configsync

Documentation

Index

• Constants
• type AuthType

Constants

const (
	// GroupName is the name of the group of configsync resources.
	GroupName = "configsync.gke.io"

	// ConfigSyncPrefix is the prefix for all ConfigSync annotations and labels.
	ConfigSyncPrefix = GroupName + "/"

	// FieldManager is the field manager name for server-side apply.
	FieldManager = GroupName

	// ControllerNamespace is the Namespace used for Nomos controllers
	ControllerNamespace = "config-management-system"
)

const (
	// RepoSyncName is the expected name of any RepoSync CR.
	RepoSyncName = "repo-sync"
	// RootSyncName is the expected name of any RootSync CR.
	RootSyncName = "root-sync"
	// RepoSyncKind is the kind of the RepoSync resource.
	RepoSyncKind = "RepoSync"
	// RootSyncKind is the kind of the RepoSync resource.
	RootSyncKind = "RootSync"
)

API type constants

const (
	// DefaultHydrationPollingPeriod is the time delay between polling the
	// filesystem for source updates to render.
	DefaultHydrationPollingPeriod = 5 * time.Second

	// DefaultHydrationRetryPeriod is the time delay between attempts to
	// re-render config after an error.
	// TODO: replace with retry-backoff strategy
	DefaultHydrationRetryPeriod = 30 * time.Minute

	// DefaultReconcilerPollingPeriodSeconds is time delay between polling the
	// filesystem for source updates to sync, in seconds.
	DefaultReconcilerPollingPeriodSeconds = 15

	// DefaultReconcilerPollingPeriod is the time delay between polling the
	// filesystem for source updates to sync.
	DefaultReconcilerPollingPeriod = DefaultReconcilerPollingPeriodSeconds * time.Second

	// DefaultReconcilerResyncPeriod is the time delay between forced re-syncs
	// from source (even without a new commit).
	DefaultReconcilerResyncPeriod = time.Hour

	// DefaultReconcilerRetryPeriod is the time delay between polling the
	// filesystem for source updates to sync, when the previous attempt errored.
	// Note: This retry period is also used for watch updates.
	// TODO: replace with retry-backoff strategy
	DefaultReconcilerRetryPeriod = time.Second

	// DefaultReconcilerSyncStatusUpdatePeriod is the time delay between async
	// status updates by the reconciler. These updates report new management
	// conflict errors from the remediator, if there are any.
	DefaultReconcilerSyncStatusUpdatePeriod = 5 * time.Second

	// DefaultReconcileTimeout is the default wait timeout used by the applier
	// when waiting for reconciliation after actuation.
	// For Apply, it waits for Current status.
	// For Delete, it waits for NotFound status.
	DefaultReconcileTimeout = 5 * time.Minute

	// DefaultHelmReleaseNamespace is the default namespace for a Helm Release which does not have a namespace specified
	DefaultHelmReleaseNamespace = "default"
)

Types

type AuthType

type AuthType string

AuthType specifies the type to authenticate to a repository.

const (
	// AuthGCENode indicates using gcenode to authenticate to Git or OCI.
	AuthGCENode AuthType = "gcenode"
	// AuthSSH indicates using an ssh key to authenticate to Git. It doesn't apply to OCI.
	AuthSSH AuthType = "ssh"
	// AuthCookieFile indicates using cookiefile to authenticate to Git. It doesn't apply to OCI.
	AuthCookieFile AuthType = "cookiefile"
	// AuthNone indicates no auth token is required for Git or OCI or Helm.
	AuthNone AuthType = "none"
	// AuthToken indicates using a username/password to authenticate to Git or Helm. It doesn't apply to OCI.
	AuthToken AuthType = "token"
	// AuthGCPServiceAccount indicates using a GCP service account to authenticate to
	// Git or OCI or Helm, when GKE Workload Identity or Fleet Workload Identity is enabled.
	AuthGCPServiceAccount AuthType = "gcpserviceaccount"
)