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.

Appears In:
Field Description

token string

Token is the actual token to register the cluster

validUntil Time

ValidUntil timespan how long the token is valid. If the token is used after this timestamp it will be rejected.

tokenValid boolean

TokenValid indicates if the token is still valid or was already used.

Cluster

Cluster is the Schema for the clusters API

Appears In:
Field Description

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

ClusterSpec

ClusterSpec defines the desired state of Cluster

Appears In:
Field Description

displayName string

DisplayName of cluster which could be different from metadata.name. Allows cluster renaming should it be needed.

gitRepoURL string

GitRepoURL git repository storing the cluster configuration catalog. If this is set, no gitRepoTemplate is needed.

gitHostKeys string

SSH GitHostKeys of the git server

gitRepoTemplate GitRepoTemplate

GitRepoTemplate template for managing the GitRepo object.

TenantRef reference to Tenant object the cluster belongs to.

tenantGitRepoRevision string

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 string

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 string

TokenLifetime set the token lifetime

facts object (keys:string, values:string)

Facts are key/value pairs for statically configured facts

deletionPolicy DeletionPolicy

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

DeletionPolicy (string)

DeletionPolicy defines the type deletion policy

DeployKey

DeployKey defines an SSH key to be used for git operations.

Appears In:
Field Description

type string

Type defines what type the key is (rsa, ed25519, etc…​)

key string

Key is the actual key

writeAccess boolean

WriteAccess if the key has RW access or not

GitRepo

GitRepo is the Schema for the gitrepos API

Appears In:
Field Description

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

GitRepoSpec

GitRepoSpec defines the desired state of GitRepo

Appears In:
Field Description

GitRepoTemplate GitRepoTemplate

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 SecretReference

APISecretRef reference to secret containing connection information

deployKeys object (keys:string, values:DeployKey)

DeployKeys optional list of SSH deploy keys. If not set, not deploy keys will be configured

path string

Path to Git repository

repoName string

RepoName name of Git repository

repoType RepoType

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 string

DisplayName of Git repository

templateFiles object (keys:string, values:string)

TemplateFiles is a list of files that should be pushed to the repository after its creation.

deletionPolicy DeletionPolicy

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

RepoType (string)

RepoType specifies the type of the repo

Appears In:

Tenant

Tenant is the Schema for the tenants API

Appears In:
Field Description

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec TenantSpec

TenantSpec

TenantSpec defines the desired state of Tenant

Appears In:
Field Description

displayName string

DisplayName is the display name of the tenant.

gitRepoURL string

GitRepoURL git repository storing the tenant configuration. If this is set, no gitRepoTemplate is needed.

gitRepoRevision string

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 string

GlobalGitRepoURL git repository storing the global configuration.

globalGitRepoRevision string

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 GitRepoTemplate

GitRepoTemplate Template for managing the GitRepo object. If not set, no GitRepo object will be created.

deletionPolicy DeletionPolicy

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

clusterTemplate ClusterSpec

ClusterTemplate defines a template which will be used to set defaults for the clusters of this tenant. The fields whitin this can use Go templating. See [the docs](syn.tools/lieutenant-operator/explanation/templating.html) for details.

TenantTemplate

TenantTemplate is the Schema for the tenant templates API

Appears In:
Field Description

apiVersion string

syn.tools/v1alpha1

kind string

TenantTemplate

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec TenantSpec

TenantTemplateList

TenantTemplateList contains a list of TenantTemplate

Field Description

apiVersion string

syn.tools/v1alpha1

kind string

TenantTemplateList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.