Documentation
¶
Overview ¶
Package libarcane contains shared compatibility helpers, setting utilities, and internal resource metadata used across Arcane's backend and CLI.
Index ¶
- Constants
- func ArcaneImageRegistryHost(registry string) string
- func ArcaneRegistryHost(registry string) string
- func CurrentContainerInspectTarget(currentContainerID, hostname func() (string, error)) (string, error)
- func FindArcaneContainerIDByLabel(ctx context.Context, dockerClient *client.Client) string
- func InspectCurrentArcaneContainer(ctx context.Context, dockerClient *client.Client) (*container.InspectResponse, error)
- func IsCronSettingKey(key string) bool
- func TimeoutSettingKeys() []string
- func ValidateCronSetting(key, value string) error
- type SettingUpdate
Constants ¶
const ( // UpgradeLogDirectory is mounted into the upgrader to persist its logs. UpgradeLogDirectory = "/app/data" // InternalResourceLabel marks containers used for Arcane utilities. InternalResourceLabel = "com.getarcaneapp.internal.resource" // HiddenResourceLabel hides containers from container lists and dashboard counts. HiddenResourceLabel = "com.getarcaneapp.arcane.hidden" // LabelArcaneUpgrader marks the short-lived helper container that performs an // Arcane self-upgrade. Container lookups must skip it despite its Arcane label. LabelArcaneUpgrader = "com.getarcaneapp.arcane.upgrader" )
const ( DepotTokenSettingKey = "depotToken" GHCRRegistryHost = "ghcr.io" DockerHubRegistryHost = "docker.io" ECRPublicRegistryHost = "public.ecr.aws" )
Variables ¶
This section is empty.
Functions ¶
func ArcaneImageRegistryHost ¶ added in v2.15.0
ArcaneImageRegistryHost resolves the update-check registry setting; ECR Public only hosts the manager and agent images.
func ArcaneRegistryHost ¶ added in v2.10.2
ArcaneRegistryHost normalizes a registry setting to a host that mirrors the getarcaneapp images, defaulting to GHCR.
func CurrentContainerInspectTarget ¶ added in v2.8.0
func CurrentContainerInspectTarget(currentContainerID, hostname func() (string, error)) (string, error)
CurrentContainerInspectTarget resolves the identifier used to inspect Arcane's current container: the detected container ID when available, the hostname otherwise. Neither source is authoritative — under network_mode: container:<sidecar> both can resolve the netns-owning sidecar — so callers must validate the inspected container (see InspectCurrentArcaneContainer).
func FindArcaneContainerIDByLabel ¶ added in v2.8.0
FindArcaneContainerIDByLabel locates Arcane's own container through the Arcane label. Running containers win; otherwise the first match is returned. The upgrader helper is never a candidate. Returns "" when nothing matches.
func InspectCurrentArcaneContainer ¶ added in v2.8.0
func InspectCurrentArcaneContainer(ctx context.Context, dockerClient *client.Client) (*container.InspectResponse, error)
InspectCurrentArcaneContainer inspects Arcane's own container, preferring cgroup/hostname self-detection and falling back to the Arcane label.
func IsCronSettingKey ¶
func TimeoutSettingKeys ¶ added in v2.7.0
func TimeoutSettingKeys() []string
TimeoutSettingKeys returns the settings propagated to remote environments.
func ValidateCronSetting ¶
Types ¶
type SettingUpdate ¶
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package rustic provides shared Rustic runtime configuration.
|
Package rustic provides shared Rustic runtime configuration. |
|
Package vuln drives Trivy scans: building and parsing scanner invocations, plus the container-level mechanics of running one — runtime/network detection, container spec and resources, temp files, log copy and tar extraction, and report decoding.
|
Package vuln drives Trivy scans: building and parsing scanner invocations, plus the container-level mechanics of running one — runtime/network detection, container spec and resources, temp files, log copy and tar extraction, and report decoding. |