shared

package
v1.2.0-rc.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 7, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package shared holds constants and small helpers shared across packages that would otherwise need to import the full client package.

Index

Constants

View Source
const (
	HealthStatusUnknown   = "unknown"
	HealthStatusStarting  = "starting"
	HealthStatusHealthy   = "healthy"
	HealthStatusUnhealthy = "unhealthy"
	HealthStatusStopped   = "stopped"

	HealthKeyPrefix = "user.healthcheck."

	// HealthStatusKey is the instance config key used to store health status.
	HealthStatusKey = HealthKeyPrefix + "status"

	// HealthEnabledKey when "true" opts the instance in, and is the only thing
	// ic-healthd consults. On a project it means the same one level up.
	HealthEnabledKey = HealthKeyPrefix + "enabled"

	// HealthStoppedKey when "true" means healthchecking is stopped.
	HealthStoppedKey = HealthKeyPrefix + "stopped"

	// HealthIgnoreKey opts an instance out of health checking entirely.
	HealthIgnoreKey = HealthKeyPrefix + "ignore"

	// HealthScopeKey names the daemon watching a project. Missing means neither.
	HealthScopeKey = HealthKeyPrefix + "scope"
)

Health check status constants written to HealthConfigKey by ic-healthd.

View Source
const (
	HealthScopeProject = "project"
	HealthScopeGlobal  = "global"
)

Values of HealthScopeKey.

View Source
const (
	Incus72Extension = "oci_network_config"
	Incus73Extension = "instance_port_forward"
)

Those define extensions that came with a specific release.

Variables

View Source
var RestartPolicies = []string{"always", "on-failure", "unless-stopped"}

RestartPolicies are the restart values worth tracking even without a test command.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL