CRD Documentation

CRD Documentation

Packages:

syn.tools/v1alpha1

Package v1alpha1 contains API Schema definitions for the syn v1alpha1 API group

Resource Types:

    BootstrapToken

    (Appears on: ClusterStatus)

    BootstrapToken this key is used only once for Steward to register.

    Field Description

    token
    string

    Token is the actual token to register the cluster

    validUntil
    Kubernetes meta/v1.Time

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

    tokenValid
    bool

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

    Cluster

    Cluster is the Schema for the clusters API

    Field Description

    metadata
    Kubernetes meta/v1.ObjectMeta

    Refer to the Kubernetes API documentation for the fields of the metadata field.

    spec
    ClusterSpec



    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
    Kubernetes core/v1.LocalObjectReference

    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
    Facts

    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

    status
    ClusterStatus

    ClusterSpec

    (Appears on: Cluster, TenantSpec)

    ClusterSpec defines the desired state of Cluster

    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
    Kubernetes core/v1.LocalObjectReference

    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
    Facts

    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

    ClusterStatus

    (Appears on: Cluster)

    ClusterStatus defines the observed state of Cluster

    Field Description

    bootstrapToken
    BootstrapToken

    BootstrapTokenValid validity of the bootstrap token, set by the Lieutenant API.

    DeletionPolicy (string alias)

    (Appears on: ClusterSpec, GitRepoTemplate, TenantSpec)

    DeletionPolicy defines the type deletion policy

    DeployKey

    (Appears on: GitRepoTemplate)

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

    Field Description

    type
    string

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

    key
    string

    Key is the actual key

    writeAccess
    bool

    WriteAccess if the key has RW access or not

    Facts (map[string]string alias)

    (Appears on: ClusterSpec)

    Facts is a map of arbitrary facts for the cluster

    GitPhase (string alias)

    (Appears on: GitRepoStatus)

    GitPhase is the enum for the git phase status

    GitRepo

    GitRepo is the Schema for the gitrepos API

    Field Description

    metadata
    Kubernetes meta/v1.ObjectMeta

    Refer to the Kubernetes API documentation for the fields of the metadata field.

    spec
    GitRepoSpec



    GitRepoTemplate
    GitRepoTemplate

    (Members of GitRepoTemplate are embedded into this type.)

    tenantRef
    Kubernetes core/v1.LocalObjectReference

    TenantRef references the tenant this repo belongs to

    status
    GitRepoStatus

    GitRepoSpec

    (Appears on: GitRepo)

    GitRepoSpec defines the desired state of GitRepo

    Field Description

    GitRepoTemplate
    GitRepoTemplate

    (Members of GitRepoTemplate are embedded into this type.)

    tenantRef
    Kubernetes core/v1.LocalObjectReference

    TenantRef references the tenant this repo belongs to

    GitRepoStatus

    (Appears on: GitRepo)

    GitRepoStatus defines the observed state of GitRepo

    Field Description

    phase
    GitPhase

    Updated by Operator with current phase. The GitPhase enum will be used for application logic as using it directly would only print an integer.

    type
    GitType

    Type autodiscovered Git repo type. Same behaviour for the enum as with the Phase.

    url
    string

    URL computed Git repository URL

    hostKeys
    string

    SSH HostKeys of the git server

    GitRepoTemplate

    (Appears on: ClusterSpec, GitRepoSpec, TenantSpec)

    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
    Kubernetes core/v1.SecretReference

    APISecretRef reference to secret containing connection information

    deployKeys
    map[string]github.com/projectsyn/lieutenant-operator/pkg/apis/syn/v1alpha1.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
    map[string]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

    GitType (string alias)

    (Appears on: GitRepoStatus)

    GitType as the enum for git types

    RepoType (string alias)

    (Appears on: GitRepoTemplate)

    RepoType specifies the type of the repo

    Tenant

    Tenant is the Schema for the tenants API

    Field Description

    metadata
    Kubernetes meta/v1.ObjectMeta

    Refer to the Kubernetes API documentation for the fields of the metadata field.

    spec
    TenantSpec



    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 for details.

    status
    TenantStatus

    TenantSpec

    (Appears on: Tenant, TenantTemplate)

    TenantSpec defines the desired state of Tenant

    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 for details.

    TenantStatus

    (Appears on: Tenant)

    TenantStatus defines the observed state of Tenant

    TenantTemplate

    TenantTemplate is the Schema for the tenant templates API

    Field Description

    metadata
    Kubernetes meta/v1.ObjectMeta

    Refer to the Kubernetes API documentation for the fields of the metadata field.

    spec
    TenantSpec



    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 for details.


    Generated with gen-crd-api-reference-docs