API Reference
This is a generated API documentation.
A more sophisticated documentation is available under doc.crds.dev/github.com/projectsyn/lieutenant-operator. |
syn.tools/v1alpha1
BootstrapToken
BootstrapToken this key is used only once for Steward to register.
Field | Description |
---|---|
|
Token is the actual token to register the cluster |
|
ValidUntil timespan how long the token is valid. If the token is used after this timestamp it will be rejected. |
|
TokenValid indicates if the token is still valid or was already used. |
Cluster
Cluster is the Schema for the clusters API
Field | Description |
---|---|
|
Refer to Kubernetes API documentation for fields of |
|
ClusterSpec
ClusterSpec defines the desired state of Cluster
Field | Description |
---|---|
|
DisplayName of cluster which could be different from metadata.name. Allows cluster renaming should it be needed. |
|
GitRepoURL git repository storing the cluster configuration catalog. If this is set, no gitRepoTemplate is needed. |
|
SSH GitHostKeys of the git server |
|
GitRepoTemplate template for managing the GitRepo object. |
|
TenantRef reference to Tenant object the cluster belongs to. |
|
TenantGitRepoRevision allows to configure the revision of the tenant configuration to use. It can be any git tree-ish reference. The revision from the tenant will be inherited if left empty. |
|
GlobalGitRepoRevision allows to configure the revision of the global configuration to use. It can be any git tree-ish reference. The revision from the tenant will be inherited if left empty. |
|
TokenLifetime set the token lifetime |
|
Facts are key/value pairs for statically configured facts |
|
DeletionPolicy defines how the external resources should be treated upon CR deletion. Retain: will not delete any external resources Delete: will delete the external resources Archive: will archive the external resources, if it supports that |
|
CreationPolicy defines how the external resources should be treated upon CR creation. Create: will only create a new external resource and will not manage already existing resources Adopt: will create a new external resource or will adopt and manage an already existing resource |
DeployKey
DeployKey defines an SSH key to be used for git operations.
Field | Description |
---|---|
|
Type defines what type the key is (rsa, ed25519, etc…) |
|
Key is the actual key |
|
WriteAccess if the key has RW access or not |
GitRepo
GitRepo is the Schema for the gitrepos API
Field | Description |
---|---|
|
Refer to Kubernetes API documentation for fields of |
|
GitRepoSpec
GitRepoSpec defines the desired state of GitRepo
Field | Description |
---|---|
|
|
|
TenantRef references the tenant this repo belongs to |
GitRepoTemplate
GitRepoTemplate is used for templating git repos, it does not contain the tenantRef as it will be added by the controller creating the template instance.
Field | Description |
---|---|
|
APISecretRef reference to secret containing connection information |
|
DeployKeys optional list of SSH deploy keys. If not set, not deploy keys will be configured |
|
Path to Git repository |
|
RepoName name of Git repository |
|
RepoType specifies if a repo should be managed by the git controller. A value of 'unmanaged' means it’s not manged by the controller |
|
DisplayName of Git repository |
|
TemplateFiles is a list of files that should be pushed to the repository after its creation. |
|
DeletionPolicy defines how the external resources should be treated upon CR deletion. Retain: will not delete any external resources Delete: will delete the external resources Archive: will archive the external resources, if it supports that |
|
CreationPolicy defines how the external resources should be treated upon CR creation. Create: will only create a new external resource and will not manage already existing resources Adopt: will create a new external resource or will adopt and manage an already existing resource |
Tenant
Tenant is the Schema for the tenants API
Field | Description |
---|---|
|
Refer to Kubernetes API documentation for fields of |
|
TenantSpec
TenantSpec defines the desired state of Tenant
Field | Description |
---|---|
|
DisplayName is the display name of the tenant. |
|
GitRepoURL git repository storing the tenant configuration. If this is set, no gitRepoTemplate is needed. |
|
GitRepoRevision allows to configure the revision of the tenant configuration to use. It can be any git tree-ish reference. Defaults to HEAD if left empty. |
|
GlobalGitRepoURL git repository storing the global configuration. |
|
GlobalGitRepoRevision allows to configure the revision of the global configuration to use. It can be any git tree-ish reference. Defaults to HEAD if left empty. |
|
GitRepoTemplate Template for managing the GitRepo object. If not set, no GitRepo object will be created. |
|
DeletionPolicy defines how the external resources should be treated upon CR deletion. Retain: will not delete any external resources Delete: will delete the external resources Archive: will archive the external resources, if it supports that |
|
CreationPolicy defines how the external resources should be treated upon CR creation. Create: will only create a new external resource and will not manage already existing resources Adopt: will create a new external resource or will adopt and manage an already existing resource |
|
ClusterTemplate defines a template which will be used to set defaults for the clusters of this tenant. The fields within this can use Go templating. See syn.tools/lieutenant-operator/explanations/templating.html for details. |
TenantTemplate
TenantTemplate is the Schema for the tenant templates API
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|
TenantTemplateList
TenantTemplateList contains a list of TenantTemplate
Field | Description |
---|---|
|
|
|
|
|
Refer to Kubernetes API documentation for fields of |
|