configsync

Documentation

Index

• Constants
• type AuthType
• type NamespaceStrategy
• type SourceFormat
• type SourceType

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 used by the reconciler.
	// This avoids conflicts between the reconciler and reconciler-manager.
	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"
	// RootSyncCRDName is the name of RootSync CRD
	RootSyncCRDName = "rootsyncs.configsync.gke.io"
	// RepoSyncCRDName is the name of RepoSync CRD
	RepoSyncCRDName = "reposyncs.configsync.gke.io"
	// ResourceGroupCRDName is the name of the ResourceGroup CRD
	ResourceGroupCRDName = "resourcegroups.kpt.dev"
)

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

	// DefaultHelmSyncVersionPollingPeriod is time delay between polling for
	// helm chart version updates in helm-sync.
	DefaultHelmSyncVersionPollingPeriod = 1 * time.Hour

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

	// DefaultReconcilerFullSyncPeriod is the time delay between forced re-syncs
	// from source (even without a new commit).
	DefaultReconcilerFullSyncPeriod = 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"
	// AuthK8sServiceAccount indicates using a Kubernetes service account with
	// GKE or Fleet Workload Identity to authenticate to GCP services.
	AuthK8sServiceAccount AuthType = "k8sserviceaccount"
	// AuthGithubApp indicates using a GitHub app to authenticate with Git.
	AuthGithubApp AuthType = "githubapp"
)

type NamespaceStrategy

type NamespaceStrategy string

NamespaceStrategy specifies the strategy used by the reconciler for undeclared namespaces.

const (
	// NamespaceStrategyImplicit indicates that the reconciler should create
	// "implicit" namespaces if they are not declared. Default
	NamespaceStrategyImplicit NamespaceStrategy = "implicit"
	// NamespaceStrategyExplicit indicates that namespaces must be explicitly
	// declared to be created by the reconciler.
	NamespaceStrategyExplicit NamespaceStrategy = "explicit"
)

type SourceFormat

type SourceFormat string

SourceFormat specifies how the Importer should parse the repository.

const (
	// SourceFormatUnstructured says to parse all YAMLs in the config directory and
	// ignore directory structure.
	SourceFormatUnstructured SourceFormat = "unstructured"

	// SourceFormatHierarchy says to use hierarchical namespace inheritance based on
	// directory structure and requires that manifests be declared in specific
	// subdirectories.
	SourceFormatHierarchy SourceFormat = "hierarchy"
)

type SourceType

type SourceType string

SourceType specifies the type of the source of truth.

const (
	// GitSource represents the source type is Git repository.
	GitSource SourceType = "git"

	// OciSource represents the source type is OCI package.
	OciSource SourceType = "oci"

	// HelmSource represents the source type is Helm repository.
	HelmSource SourceType = "helm"
)