API

OIDConfig configures the OIDC provider.

SCIMConfig configures the SCIM client.

Name is the name of the PluginDefinition to patch with an alias

Alias is the alias to apply to the PluginDefinition Name via Kustomize patches For SourceType Helm, this field is passed to postRender Kustomize patch

Repository is the repository to override in the PluginDefinition .spec.helmChart.repository

Repository - the Git repository URL

Resources contains the list of path to PluginDefinition files e.g. [“plugins/plugin-a.yaml”, “plugins/plugin-b.yaml”] glob patterns are supported, e.g. [“plugins/*.yaml”, “more-plugins/**/plugindefinition.yaml”]

Ref is the git reference (branch, tag, or SHA) to resolve PluginDefinitions from precedence: SHA > Tag > Branch if not specified, defaults to the branch “main”

SecretName is the name of v1.Secret containing credentials to access the Git repository the secret must be in the same namespace as the Catalog resource

  GitHub App Example:
-------------------
githubAppID: "<app-id>"
githubAppInstallationID: "<app-installation-id>"
githubAppPrivateKey: |
-----BEGIN RSA PRIVATE KEY-----
...
-----END RSA PRIVATE KEY-----
githubAppBaseURL: "<github-enterprise-api-url>" #optional, required only for GitHub Enterprise Server users
ca.crt: | #optional, for GitHub Enterprise Server users
-----BEGIN CERTIFICATE-----
...
-----END CERTIFICATE-----
GitHub Token Example:
-------------------
username: <BASE64>
password: <BASE64>
ca.crt: <BASE64> #optional, for GitHub Enterprise Server users

Overrides are the PluginDefinition overrides to be applied

Sources contains the list of Git Repository source to resolve PluginDefinitions / ClusterPluginDefinitions from

StatusConditions contain the different conditions that constitute the status of the Catalog

Inventory contains list of internal artifacts generated by Catalog

MaxTokenValidity specifies the maximum duration for which a token remains valid in hours.

StatusConditions contain the different conditions that constitute the status of the Plugin.

AccessMode configures how the cluster is accessed from the Greenhouse operator.

KubeConfig contains specific values for KubeConfig for the cluster.

KubernetesVersion reflects the detected Kubernetes version of the cluster.

BearerTokenExpirationTimestamp reflects the expiration timestamp of the bearer token used to access the cluster.

StatusConditions contain the different conditions that constitute the status of the Cluster.

Nodes contain a short summary of nodes count and not ready nodes status.

Name of the HelmChart chart.

Repository of the HelmChart chart.

Version of the HelmChart chart.

Status is the status of a HelmChart release.

FirstDeployed is the timestamp of the first deployment of the release.

LastDeployed is the timestamp of the last deployment of the release.

PluginOptionChecksum is the checksum of plugin option values.

Diff contains the difference between the deployed helm chart and the helm chart in the last reconciliation

Name of the node.

Message represents the error message.

LastTransitionTime represents latest transition time of status.

Total represent the number of all the nodes in the cluster.

ReadyNodes represent the number of ready nodes in the cluster.

NotReady is slice of non-ready nodes status details.

Issuer is the URL of the identity service.

RedirectURI is the redirect URI to be used for the OIDC flow against the upstream IdP. If none is specified, the Greenhouse ID proxy will be used.

ClientIDReference references the Kubernetes secret containing the client id.

ClientSecretReference references the Kubernetes secret containing the client secret.

OAuth2ClientRedirectURIs are a registered set of redirect URIs. When redirecting from the idproxy to the client application, the URI requested to redirect to must be contained in this list.

DisplayName is an optional name for the organization to be displayed in the Greenhouse UI. Defaults to a normalized version of metadata.name.

Authentication configures the organizations authentication mechanism.

Description provides additional details of the organization.

MappedOrgAdminIDPGroup is the IDP group ID identifying org admins

ConfigMapRef allows to reference organizational config map.

StatusConditions contain the different conditions that constitute the status of the Organization.

Name of the referenced PluginDefinition or ClusterPluginDefinition resource.

Kind of the referent. Supported values: PluginDefinition, ClusterPluginDefinition.

DisplayName provides a human-readable label for the pluginDefinition.

Description provides additional details of the pluginDefinition.

HelmChart specifies where the Helm Chart for this pluginDefinition can be found.

UIApplication specifies a reference to a UI application

RequiredValues is a list of values required to create an instance of this PluginDefinition.

Version of this pluginDefinition

Weight configures the order in which Plugins are shown in the Greenhouse UI. Defaults to alphabetical sorting if not provided or on conflict.

Icon specifies the icon to be used for this plugin in the Greenhouse UI. Icons can be either: - A string representing a juno icon in camel case from this list: https://github.com/sapcc/juno/blob/main/libs/juno-ui-components/src/components/Icon/Icon.component.js#L6-L52 - A publicly accessible image reference to a .png file. Will be displayed 100x100px

DocMarkDownUrl specifies the URL to the markdown documentation file for this plugin. Source needs to allow all CORS origins.

StatusConditions contain the different conditions that constitute the status of the Plugin.

Name/Key of the config option.

Default provides a default value for the option

Description provides a human-readable text for the value as shown in the UI.

DisplayName provides a human-readable label for the configuration option

Required indicates that this config option is required

Type of this configuration option.

Regex specifies a match rule for validating configuration options.

Name of the values.

Value is the actual value in plain text.

ValueFrom references a potentially confidential value in another source.

Template is a Go string template that will be dynamically resolved for cluster-specific values. Only PluginOptionValues declared as template will be templated by the PluginController for Flux.

PluginSpec is the spec of the plugin to be deployed by the PluginPreset.

ClusterSelector is a label selector to select the clusters the plugin bundle should be deployed to.

ClusterOptionOverrides define plugin option values to override by the PluginPreset

WaitFor defines other Plugins to wait for before creating the Plugin.

DeletionPolicy defines how Plugins owned by a PluginPreset are handled on deletion of the PluginPreset. Supported values are “Delete” and “Orphan”. If not set, defaults to “Delete”.

StatusConditions contain the different conditions that constitute the status of the PluginPreset.

PluginStatuses contains statuses of Plugins managed by the PluginPreset.

TotalPlugins is the number of Plugins in total managed by the PluginPreset.

ReadyPlugins is the number of ready Plugins managed by the PluginPreset.

FailedPlugins is the number of failed Plugins managed by the PluginPreset.

Name of the Plugin.

PluginPreset is the name of the PluginPreset which creates the Plugin.

PluginDefinition is the name of the PluginDefinition this instance is for.

Deprecated: Use PluginDefinitionRef instead. Future releases of greenhouse will remove this field.

PluginDefinitionRef is the reference to the (Cluster-)PluginDefinition.

DisplayName is an optional name for the Plugin to be displayed in the Greenhouse UI. This is especially helpful to distinguish multiple instances of a PluginDefinition in the same context. Defaults to a normalized version of metadata.name.

Values are the values for a PluginDefinition instance.

ClusterName is the name of the cluster the plugin is deployed to. If not set, the plugin is deployed to the greenhouse cluster.

ReleaseNamespace is the namespace in the remote cluster to which the backend is deployed. Defaults to the Greenhouse managed namespace if not set.

ReleaseName is the name of the helm release in the remote cluster to which the backend is deployed. If the Plugin was already deployed, the Plugin’s name is used as the release name. If this Plugin is newly created, the releaseName is defaulted to the PluginDefinitions HelmChart name.

WaitFor defines other Plugins to wait for before installing this Plugin.

HelmReleaseStatus reflects the status of the latest HelmChart release. This is only configured if the pluginDefinition is backed by HelmChart.

Version contains the latest pluginDefinition version the config was last applied with successfully.

HelmChart contains a reference the helm chart used for the deployed pluginDefinition version.

UIApplication contains a reference to the frontend that is used for the deployed pluginDefinition version.

Weight configures the order in which Plugins are shown in the Greenhouse UI.

Description provides additional details of the plugin.

ExposedServices provides an overview of the Plugins services that are centrally exposed. It maps the exposed URL to the service found in the manifest.

StatusConditions contain the different conditions that constitute the status of the Plugin.

ClusterName is the name of the cluster the rbacv1 resources are created on.

Condition is the overall Status of the rbacv1 resources created on the cluster

URL to the SCIM server.

AuthType defined possible authentication type

User to be used for basic authentication.

Password to be used for basic authentication.

BearerToken to be used for bearer token authorization

BearerPrefix to be used to defined bearer token prefix

BearerHeader to be used to defined bearer token header

Name of the secret in the same namespace.

Key in the secret to select the value from.

Namespace is the namespace of the service in the target cluster.

Name is the name of the service in the target cluster.

Port is the port of the service. Zero for ingresses where port is not applicable.

Protocol is the protocol of the service.

Type is the type of exposed service.

TeamRoleRef references a Greenhouse TeamRole by name

TeamRef references a Greenhouse Team by name

Usernames defines list of users to add to the (Cluster-)RoleBindings

ClusterName is the name of the cluster the rbacv1 resources are created on.

ClusterSelector is a label selector to select the Clusters the TeamRoleBinding should be deployed to.

Namespaces is a list of namespaces in the Greenhouse Clusters to apply the RoleBinding to. If empty, a ClusterRoleBinding will be created on the remote cluster, otherwise a RoleBinding per namespace.

CreateNamespaces when enabled the controller will create namespaces for RoleBindings if they do not exist.

StatusConditions contain the different conditions that constitute the status of the TeamRoleBinding.

PropagationStatus is the list of clusters the TeamRoleBinding is applied to

Rules is a list of rbacv1.PolicyRules used on a managed RBAC (Cluster)Role

AggregationRule describes how to locate ClusterRoles to aggregate into the ClusterRole on the remote cluster

Labels are applied to the ClusterRole created on the remote cluster. This allows using TeamRoles as part of AggregationRules by other TeamRoles

Description provides additional details of the team.

IdP group id matching team.

URL to join the IdP group.

URL specifies the url to a built javascript asset. By default, assets are loaded from the Juno asset server using the provided name and version.

Name of the UI application.

Version of the frontend application.

ID is the unique identifier of the user.

FirstName of the user.

LastName of the user.

Email of the user.

Secret references the secret containing the value.

PluginRef defines a reference to the Plugin.

Name of a single Cluster to select.

LabelSelector is a label query over a set of Clusters.

ClusterName is the name of the cluster the rbacv1 resources are created on.

Condition is the overall Status of the rbacv1 resources created on the cluster

TeamRoleRef references a Greenhouse TeamRole by name

TeamRef references a Greenhouse Team by name

Usernames defines list of users to add to the (Cluster-)RoleBindings

ClusterSelector is used to select a Cluster or Clusters the TeamRoleBinding should be deployed to.

Namespaces is a list of namespaces in the Greenhouse Clusters to apply the RoleBinding to. If empty, a ClusterRoleBinding will be created on the remote cluster, otherwise a RoleBinding per namespace.

CreateNamespaces when enabled the controller will create namespaces for RoleBindings if they do not exist.

StatusConditions contain the different conditions that constitute the status of the TeamRoleBinding.

PropagationStatus is the list of clusters the TeamRoleBinding is applied to