All options can be set via a config file. Most options are also available as CLI parameters.
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--registry |
registry.active |
Boolean | false |
Installs a simple cluster-local registry for demonstration purposes. Warning: Registry does not provide authentication! |
--internal-registry-port |
registry.internalPort |
Integer | 30000 |
Port of registry registry. Ignored when a registry*url params are set |
--registry-url |
registry.url |
String | `` | The url of your external registry, used for pushing images |
--registry-path |
registry.path |
String | `` | Optional when registry-url is set |
--registry-username |
registry.username |
String | `` | Optional when registry-url is set |
--registry-password |
registry.password |
String | `` | Optional when registry-url is set |
| - | registry.credentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.credentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.credentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.credentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.credentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
--registry-proxy-url |
registry.proxyUrl |
String | `` | The url of your proxy-registry. Used in pipelines to authorize pull base images. Use in conjunction with petclinic base image. Used in helm charts when create-image-pull-secrets is set. Use in conjunction with helm.*image fields. |
--registry-proxy-path |
registry.proxyPath |
String | `` | Optional when registry-proxy-url is set and the registry is running on a non root web path. |
--registry-proxy-username |
registry.proxyUsername |
String | `` | Use with registry-proxy-url, added to Jenkins as credentials and created as pull secrets, when create-image-pull-secrets is set. |
--registry-proxy-password |
registry.proxyPassword |
String | `` | Use with registry-proxy-url, added to Jenkins as credentials and created as pull secrets, when create-image-pull-secrets is set. |
| - | registry.proxyCredentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.proxyCredentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.proxyCredentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.proxyCredentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.proxyCredentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
--registry-username-read-only |
registry.readOnlyUsername |
String | `` | Optional alternative username for registry-url with read-only permissions that is used when create-image-pull-secrets is set. |
--registry-password-read-only |
registry.readOnlyPassword |
String | `` | Optional alternative password for registry-url with read-only permissions that is used when create-image-pull-secrets is set. |
| - | registry.readOnlyCredentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.readOnlyCredentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.readOnlyCredentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.readOnlyCredentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | registry.readOnlyCredentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
--create-image-pull-secrets |
registry.createImagePullSecrets |
Boolean | false |
Create image pull secrets for registry and proxy-registry for all GOP namespaces and helm charts. Uses proxy-username, read-only-username or registry-username (in this order). Use this if your cluster is not auto-provisioned with credentials for your private registries or if you configure individual helm images to be pulled from the proxy-registry that requires authentication. |
--registry-namespace |
registry.namespace |
String | registry |
Optional defines the kubernetes namespace for registry. |
| - | registry.helm.values |
Map | {} |
Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration |
| - | registry.helm.chart |
String | docker-registry |
Name of the Helm chart |
| - | registry.helm.repoURL |
String | https://twuni.github.io/docker-registry.helm |
Repository url from which the Helm chart should be obtained |
| - | registry.helm.version |
String | 3.0.0 |
The version of the Helm chart to be installed |
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--jenkins |
jenkins.active |
Boolean | false |
Installs Jenkins as CI server |
--jenkins-skip-restart |
jenkins.skipRestart |
Boolean | false |
Skips restarting Jenkins after plugin installation. Use with caution! If the plugins are not installed up front, the installation will likely fail. The intended use case for this is after the first installation, for config changes only. Do not use on first installation or upgrades. |
--jenkins-skip-plugins |
jenkins.skipPlugins |
Boolean | false |
Skips plugin installation. Use with caution! If the plugins are not installed up front, the installation will likely fail. The intended use case for this is after the first installation, for config changes only. Do not use on first installation or upgrades. |
--jenkins-url |
jenkins.url |
String | `` | The url of your external jenkins |
--jenkins-username |
jenkins.username |
String | admin |
Mandatory when jenkins-url is set |
--jenkins-password |
jenkins.password |
String | vDvTomVzAqI1 |
Mandatory when jenkins-url is set |
| - | jenkins.credentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | jenkins.credentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | jenkins.credentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | jenkins.credentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | jenkins.credentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
--jenkins-metrics-username |
jenkins.metricsUsername |
String | metrics |
Mandatory when jenkins-url is set and monitoring enabled |
--jenkins-metrics-password |
jenkins.metricsPassword |
String | metrics |
Mandatory when jenkins-url is set and monitoring enabled |
| - | jenkins.metricsCredentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | jenkins.metricsCredentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | jenkins.metricsCredentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | jenkins.metricsCredentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | jenkins.metricsCredentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
--jenkins-image |
jenkins.jenkinsImage |
String | `` | Sets image for Jenkins |
--maven-central-mirror |
jenkins.mavenCentralMirror |
String | `` | URL for maven mirror, used by applications built in Jenkins |
| - | jenkins.oidc.providerName |
String | Keycloak |
Name of the OIDC provider displayed in tool login screens |
| - | jenkins.oidc.issuerUrl |
String | `` | OIDC issuer URL, for example http://keycloak.local.gd/realms/gop |
| - | jenkins.oidc.clientId |
String | jenkins |
OIDC client ID |
| - | jenkins.oidc.clientSecret |
String | `` | OIDC client secret |
| - | jenkins.oidc.scopes |
List<String> | [openid, profile, email] |
OIDC scopes requested by the tool |
| - | jenkins.oidc.adminGroupName |
String | `` | OIDC group that receives full admin permissions in all OIDC-enabled tools |
--jenkins-additional-envs |
jenkins.additionalEnvs |
Map | {} |
Set additional environments to Jenkins |
| - | jenkins.helm.values |
Map | {} |
Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration |
| - | jenkins.helm.chart |
String | jenkins |
Name of the Helm chart |
| - | jenkins.helm.repoURL |
String | https://charts.jenkins.io |
Repository url from which the Helm chart should be obtained |
| - | jenkins.helm.version |
String | 5.13.3 |
The version of the Helm chart to be installed |
--jenkins-namespace |
jenkins.namespace |
String | jenkins |
Optional defines the kubernetes namespace for Jenkins. |
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--central-scm-provider |
multiTenant.scmProviderType |
ScmProviderType | SCM_MANAGER |
The SCM provider type. Possible values: SCM_MANAGER, GITLAB |
--central-gitlab-url |
multiTenant.gitlab.url |
String | - |
URL for external Gitlab |
--central-gitlab-username |
multiTenant.gitlab.username |
String | - |
GitLab username for API access. Must be 'oauth2' when using Personal Access Token (PAT) authentication |
--central-gitlab-token |
multiTenant.gitlab.password |
String | - |
Password for SCM Manager authentication |
| - | multiTenant.gitlab.credentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | multiTenant.gitlab.credentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | multiTenant.gitlab.credentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | multiTenant.gitlab.credentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | multiTenant.gitlab.credentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
--central-gitlab-group-id |
multiTenant.gitlab.parentGroupId |
String | - |
Main Group for Gitlab where the GOP creates it's groups/repos |
| - | multiTenant.gitlab.technicalUsername |
String | - |
Existing technical GitLab user that receives Developer access to repositories provisioned by GOP |
--central-scmm-internal |
multiTenant.scmManager.internal |
Boolean | - |
SCM for Central Management is running on the same cluster, so k8s internal URLs can be used for access |
--central-scmm-url |
multiTenant.scmManager.url |
String | - |
URL for the centralized Management Repo |
--central-scmm-username |
multiTenant.scmManager.username |
String | - |
CENTRAL SCMM username |
--central-scmm-password |
multiTenant.scmManager.password |
String | - |
CENTRAL SCMM password |
| - | multiTenant.scmManager.credentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | multiTenant.scmManager.credentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | multiTenant.scmManager.credentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | multiTenant.scmManager.credentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | multiTenant.scmManager.credentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
--central-scmm-namespace |
multiTenant.scmManager.namespace |
String | - |
Namespace where to find the Central SCMM |
--central-argocd-namespace |
multiTenant.centralArgocdNamespace |
String | argocd |
Namespace for the centralized Argocd |
--dedicated-instance |
multiTenant.useDedicatedInstance |
Boolean | false |
Toggles the Dedicated Instances Mode. See docs for more info |
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--scm-provider |
scm.scmProviderType |
ScmProviderType | SCM_MANAGER |
The SCM provider type. Possible values: SCM_MANAGER, GITLAB |
| - | scm.gitlab.internal |
Boolean | - |
True if Gitlab is running in the same K8s cluster. For now we only support access by external URL |
--gitlab-url |
scm.gitlab.url |
String | - |
Base URL for the Gitlab instance |
--gitlab-username |
scm.gitlab.username |
String | - |
Defaults to: oauth2.0 when PAT token is given. |
--gitlab-token |
scm.gitlab.password |
String | - |
PAT Token for the account. Needs read/write repo permissions. See docs for mor information |
| - | scm.gitlab.credentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | scm.gitlab.credentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | scm.gitlab.credentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | scm.gitlab.credentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | scm.gitlab.credentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
--gitlab-group-id |
scm.gitlab.parentGroupId |
String | - |
Number for the Gitlab Group where the repos and subgroups should be created |
| - | scm.gitlab.technicalUsername |
String | - |
Existing technical GitLab user that receives Developer access to repositories provisioned by GOP |
--scmm-url |
scm.scmManager.url |
String | - |
The host of your external scm-manager |
--scmm-namespace |
scm.scmManager.namespace |
String | - |
Namespace where SCM-Manager should run |
--scmm-username |
scm.scmManager.username |
String | - |
Mandatory when scmm-url is set |
--scmm-password |
scm.scmManager.password |
String | - |
Mandatory when scmm-url is set |
| - | scm.scmManager.credentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | scm.scmManager.credentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | scm.scmManager.credentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | scm.scmManager.credentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | scm.scmManager.credentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
--scmm-technical-password |
scm.scmManager.technicalUser.password |
String | - |
Password of an existing technical SCM-Manager user used by Jenkins for Git repository access when SCM-Manager is external |
| - | scm.scmManager.helm.values |
Map | - |
Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration |
| - | scm.scmManager.helm.chart |
String | - |
Name of the Helm chart |
| - | scm.scmManager.helm.repoURL |
String | - |
Repository url from which the Helm chart should be obtained |
| - | scm.scmManager.helm.version |
String | - |
The version of the Helm chart to be installed |
--scmm-image |
scm.scmManager.scmmImage |
String | - |
Sets image for SCM-Manager |
--scmm-skip-restart |
scm.scmManager.skipRestart |
Boolean | - |
Skips restarting SCM-Manager after plugin installation. Use with caution! If the plugins are not installed up front, the installation will likely fail. The intended use case for this is after the first installation, for config changes only. Do not use on first installation or upgrades.' |
--scmm-skip-plugins |
scm.scmManager.skipPlugins |
Boolean | - |
Skips plugin installation. Use with caution! If the plugins are not installed up front, the installation will likely fail. The intended use case for this is after the first installation, for config changes only. Do not use on first installation or upgrades. |
| - | scm.scmManager.gopManagedTechnicalUsername |
String | - |
Username of the GOP-managed technical SCM-Manager user |
GitLab is treated as an externally managed SCM provider. technicalUsername optionally identifies an existing technical GitLab user that receives Developer access to repositories provisioned by GOP. GOP does not create or manage this account.
The configured GitLab credentials are currently used both for GOP API provisioning and, when Jenkins is managed by GOP, for the Jenkins scm-user Git credential. Separate provisioning and technical Git credentials are not supported for GitLab yet and are intentionally deferred until there is a concrete use case.
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--config-file |
application.configFiles |
List<String> | [] |
- |
--config-map |
application.configMaps |
List<String> | [] |
- |
-d, --debug |
application.debug |
Boolean | false |
- |
-x, --trace |
application.trace |
Boolean | false |
- |
--output-config-file |
application.outputConfigFile |
Boolean | false |
- |
-v, --version |
application.versionInfoRequested |
Boolean | false |
- |
-h, --help |
application.usageHelpRequested |
Boolean | false |
- |
--insecure |
application.insecure |
Boolean | false |
Sets insecure-mode in cURL which skips cert validation |
--openshift |
application.openshift |
Boolean | false |
When set, openshift specific resources and configurations are applied |
--username |
application.username |
String | admin |
Set initial admin username |
--password |
application.password |
String | vDvTomVzAqI1 |
Set initial admin passwords |
| - | application.credentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | application.credentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | application.credentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | application.credentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | application.credentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
-y, --yes |
application.yes |
Boolean | false |
Skip confirmation |
--name-prefix |
application.namePrefix |
String | `` | Set name-prefix for repos, jobs, namespaces |
--destroy |
application.destroy |
Boolean | false |
Unroll playground |
--pod-resources |
application.podResources |
Boolean | false |
Write kubernetes resource requests and limits on each pod |
--git-name |
application.gitName |
String | Cloudogu |
Sets git author and committer name used for initial commits |
--git-email |
application.gitEmail |
String | hello@cloudogu.com |
Sets git author and committer email used for initial commits |
--base-url |
application.baseUrl |
String | `` | the external base url (TLD) for all tools, e.g. https://example.com or http://localhost:8080. The individual -url params for argocd, grafana and vault take precedence. |
--url-separator-hyphen |
application.urlSeparatorHyphen |
Boolean | false |
Use hyphens instead of dots to separate application name from base-url |
--mirror-repos |
application.mirrorRepos |
Boolean | false |
Changes the sources of deployed tools so they are not pulled from the internet, but are pulled from git and work in air-gapped environments. |
--skip-crds |
application.skipCrds |
Boolean | false |
Skip installation of CRDs. This requires prior installation of CRDs |
--namespace-isolation |
application.namespaceIsolation |
Boolean | false |
Configure tools to explicitly work with the given namespaces only, and not cluster-wide. This way GOP can be installed without having cluster-admin permissions. |
--netpols |
application.netpols |
Boolean | false |
Sets Network Policies |
| - | application.networkPolicies.bootstrapCidrs |
List<String> | [] |
CIDR ranges allowed to access internal GOP services when GOP is run outside the Kubernetes cluster |
| - | application.networkPolicies.registryAccessCidrs |
List<String> | [] |
CIDR ranges allowed to access the internal registry through its exposed service. An empty list adds no external registry ingress allowance |
| - | application.networkPolicies.egressIsolation |
Boolean | false |
Explicitly enable Argo CD repo-server egress isolation when supported external egress connections are configured |
| - | application.networkPolicies.externalConnections |
List<ExternalConnectionSchema> | [] |
External network connections for supported GOP workloads. Currently Argo CD repo-server egress is supported |
| - | application.networkPolicies.externalConnections[].name |
String | `` | Stable name of the external network connection |
| - | application.networkPolicies.externalConnections[].tool |
String | `` | Supported GOP workload identifier. Currently argocd-repo-server is supported |
| - | application.networkPolicies.externalConnections[].direction |
String | `` | NetworkPolicy direction of the external connection. Currently egress is supported for argocd-repo-server |
| - | application.networkPolicies.externalConnections[].cidrs |
List<String> | [] |
CIDR ranges allowed for the external connection |
| - | application.networkPolicies.externalConnections[].ports |
List<ExternalConnectionPortSchema> | [] |
Ports allowed for the external connection |
| - | application.networkPolicies.externalConnections[].ports[].protocol |
String | TCP |
Protocol of the allowed port, for example TCP or UDP |
| - | application.networkPolicies.externalConnections[].ports[].port |
Integer | - |
Allowed network port |
--cluster-admin |
application.clusterAdmin |
Boolean | false |
Binds ArgoCD controllers to cluster-admin ClusterRole |
-p, --profile |
application.profile |
String | - |
Use predefined profile (full, only-argocd, operator-mandants aso.) |
--gop-namespace |
application.gopNamespace |
String | `` | If set, GOP stores specific information in this namespace. |
-n, --namespace |
application.namespace |
String | `` | If set, GOP uses the same Kubernetes namespace for all tools and examples. Attention! Only use for test purposes. |
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
| - | content.namespaces |
List<String> | [] |
Additional kubernetes namespaces. These are authorized to Argo CD, supplied with image pull secrets, monitored by prometheus, etc. Namespaces can be templates, e.g. ${config.application.namePrefix}staging |
| - | content.repos |
List<ContentRepositorySchema> | [] |
ContentLoader repos to push into target environment |
| - | content.repos[].url |
String | `` | URL of the content repo. Mandatory for each type. |
| - | content.repos[].path |
String | . |
Path within the content repo to process |
| - | content.repos[].ref |
String | `` | Reference for a specific branch, tag, or commit. Emtpy defaults to default branch of the repo. With type MIRROR: ref must not be a commit hash; Choosing a ref only mirrors the ref but does not delete other branches/tags! |
| - | content.repos[].targetRef |
String | `` | Reference for a specific branch or tag in the target repo of a MIRROR or COPY repo. If ref is a tag, targetRef is treated as tag as well. Except: targetRef is full ref like refs/heads/my-branch or refs/tags/my-tag. Empty defaults to the source ref. |
| - | content.repos[].credentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | content.repos[].credentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | content.repos[].credentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | content.repos[].credentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | content.repos[].credentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | content.repos[].templating |
Boolean | false |
When true, template all files ending in .ftl within the repo |
| - | content.repos[].type |
ContentRepoType | MIRROR |
ContentLoader Repos can either be: copied (only the files, starting on ref, starting at path within the repo. Requires target) , mirrored (FORCE pushes ref or the whole git repo if no ref set). Requires target, does not allow path and template.) folderBased (folder structure is interpreted as repos. That is, root folder becomes namespace in SCM, sub folders become repository names in SCM, files are copied. Requires target.) |
| - | content.repos[].target |
String | `` | Target repo for the repository in the for of namespace/name. Must contain one slash to separate namespace from name. |
| - | content.repos[].overwriteMode |
OverwriteMode | INIT |
This defines, how customer repos will be updated. INIT - push only if repo does not exist. RESET - delete all files after cloning source - files not in content are deleted UPGRADE - clone and copy - existing files will be overwritten, files not in content are kept. For type: MIRROR reset and upgrade have same result: in both cases source repo will be force pushed to target repo. |
| - | content.repos[].createJenkinsJob |
Boolean | false |
If true, creates a Jenkins job, if jenkinsfile exists in one of the content repo's branches. |
| - | content.variables |
Map | {} |
Additional variables to use in custom templates. |
| - | content.helmReleases |
List<HelmReleaseSchema> | [] |
Additional Helm releases to deploy through Argo CD without requiring a content Git repository. |
| - | content.helmReleases[].name |
String | `` | Logical name of the Helm release. Used as the feature folder name under 'apps/' and as default for 'releaseName' if not set. |
| - | content.helmReleases[].repoURL |
String | `` | Helm repository URL to fetch the chart from. Use an HTTP(S) Helm repo (must provide an index.yaml) or an OCI registry URL (oci://...). |
| - | content.helmReleases[].chart |
String | `` | Helm chart name to install. For HTTP(S) repos this is the chart name from the repo index; for OCI this is the chart artifact name. |
| - | content.helmReleases[].version |
String | `` | Chart version to deploy. Required for Helm charts in Argo CD. For HTTP(S) Helm repos you may use a SemVer range like '*' to always pick the newest version. For OCI registries, specify an explicit version/tag. |
| - | content.helmReleases[].namespace |
String | `` | Kubernetes namespace to deploy the release into. |
| - | content.helmReleases[].releaseName |
String | `` | Helm release name. If empty, the value of 'name' is used. |
| - | content.helmReleases[].valuesPath |
String | `` | Optional path to a YAML values file to load Helm values from.The file must be accessible locally on the machine running GOP. Inline 'values' will be merged on top (inline overrides file). |
| - | content.helmReleases[].values |
Map | {} |
Optional inline Helm values. These values are merged on top of 'valuesFile' (if set) and override keys from the file. Use this for small overrides without maintaining a separate file. |
--content-whitelist |
content.useWhitelist |
Boolean | false |
Enables the whitelist for statics in content templating |
| - | content.allowedStaticsWhitelist |
Set<String> | [com.cloudogu.gitops.utils.DockerImageParser, java.lang.Float, java.lang.Long, java.lang.Double, java.lang.Boolean, java.lang.Math, java.lang.String, java.lang.Integer] |
Whitelist for Statics freemarker is allowing in user templates |
Configuration of optional tools supported by gitops-playground.
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--argocd |
features.argocd.active |
Boolean | false |
Install ArgoCD |
--argocd-operator |
features.argocd.operator |
Boolean | false |
Install ArgoCD via an already running ArgoCD Operator |
--argocd-url |
features.argocd.url |
String | `` | The URL where argocd is accessible. It has to be the full URL with http:// or https:// |
| - | features.argocd.env |
List<java.util.Map<java.lang.String, java.lang.String>> | - |
Pass a list of env vars to Argo CD components. Currently only works with operator |
--argocd-email-from |
features.argocd.emailFrom |
String | argocd@example.org |
Notifications, define Argo CD sender email address |
--argocd-email-to-user |
features.argocd.emailToUser |
String | app-team@example.org |
Notifications, define Argo CD user / app-team recipient email address |
--argocd-email-to-admin |
features.argocd.emailToAdmin |
String | infra@example.org |
Notifications, define Argo CD admin recipient email address |
--argocd-resource-inclusions-cluster |
features.argocd.resourceInclusionsCluster |
String | `` | Internal Kubernetes API Server URL https://IP:PORT (kubernetes.default.svc). Needed in argocd-operator resourceInclusions. Use this parameter if argocd.operator=true and NOT running inside a Pod (remote mode). Full URL needed, for example: https://100.125.0.1:443 |
--argocd-namespace |
features.argocd.namespace |
String | argocd |
Defines the kubernetes namespace for ArgoCD |
| - | features.argocd.values |
Map | {} |
Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration |
| - | features.argocd.oidc.providerName |
String | Keycloak |
Name of the OIDC provider displayed in tool login screens |
| - | features.argocd.oidc.issuerUrl |
String | `` | OIDC issuer URL, for example http://keycloak.local.gd/realms/gop |
| - | features.argocd.oidc.clientId |
String | argocd |
OIDC client ID |
| - | features.argocd.oidc.clientSecret |
String | `` | OIDC client secret |
| - | features.argocd.oidc.scopes |
List<String> | [openid, profile, email] |
OIDC scopes requested by the tool |
| - | features.argocd.oidc.adminGroupName |
String | `` | OIDC group that receives full admin permissions in all OIDC-enabled tools |
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--smtp-address |
features.mail.smtpAddress |
String | `` | Sets smtp port of external Mailserver |
--smtp-port |
features.mail.smtpPort |
Integer | - |
Sets smtp port of external Mailserver |
--smtp-user |
features.mail.smtpUser |
String | `` | Sets smtp username for external Mailserver |
--smtp-password |
features.mail.smtpPassword |
String | `` | Sets smtp password of external Mailserver |
| - | features.mail.credentials.username |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | features.mail.credentials.secretNamespace |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | features.mail.credentials.secretName |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | features.mail.credentials.usernameKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| - | features.mail.credentials.passwordKey |
String | - |
Credentials for authentication. They can reference a Kubernetes Secret via secretName and secretNamespace; usernameKey and passwordKey select the Secret data keys. |
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--metrics, --monitoring |
features.monitoring.active |
Boolean | false |
Installs the Kube-Prometheus-Stack. This includes Prometheus, the Prometheus operator, Grafana and some extra resources |
--grafana-url |
features.monitoring.grafanaUrl |
String | `` | Sets url for grafana |
--grafana-email-from |
features.monitoring.grafanaEmailFrom |
String | grafana@example.org |
Notifications, define grafana alerts sender email address |
--grafana-email-to |
features.monitoring.grafanaEmailTo |
String | infra@example.org |
Notifications, define grafana alerts recipient email address |
| - | features.monitoring.oidc.providerName |
String | Keycloak |
Name of the OIDC provider displayed in tool login screens |
| - | features.monitoring.oidc.issuerUrl |
String | `` | OIDC issuer URL, for example http://keycloak.local.gd/realms/gop |
| - | features.monitoring.oidc.clientId |
String | grafana |
OIDC client ID |
| - | features.monitoring.oidc.clientSecret |
String | `` | OIDC client secret |
| - | features.monitoring.oidc.scopes |
List<String> | [openid, profile, email] |
OIDC scopes requested by the tool |
| - | features.monitoring.oidc.adminGroupName |
String | `` | OIDC group that receives full admin permissions in all OIDC-enabled tools |
--grafana-image |
features.monitoring.helm.grafanaImage |
String | `` | Sets image for grafana |
--grafana-sidecar-image |
features.monitoring.helm.grafanaSidecarImage |
String | `` | Sets image for grafana's sidecar |
--prometheus-image |
features.monitoring.helm.prometheusImage |
String | `` | Sets image for prometheus |
--prometheus-operator-image |
features.monitoring.helm.prometheusOperatorImage |
String | `` | Sets image for prometheus-operator |
--prometheus-config-reloader-image |
features.monitoring.helm.prometheusConfigReloaderImage |
String | `` | Sets image for prometheus-operator's config-reloader |
| - | features.monitoring.helm.values |
Map | {} |
Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration |
| - | features.monitoring.helm.chart |
String | kube-prometheus-stack |
Name of the Helm chart |
| - | features.monitoring.helm.repoURL |
String | https://prometheus-community.github.io/helm-charts |
Repository url from which the Helm chart should be obtained |
| - | features.monitoring.helm.version |
String | 92.14.1 |
The version of the Helm chart to be installed |
--monitoring-namespace |
features.monitoring.namespace |
String | monitoring |
Optional defines the kubernetes namespace for monitoring. |
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--external-secrets |
features.secrets.externalSecrets.active |
Boolean | false |
Installs the external secrets operator. |
| - | features.secrets.externalSecrets.vault.storeName |
String | external-vault |
Name of the namespaced SecretStore generated for the external Vault |
| - | features.secrets.externalSecrets.vault.server |
String | `` | URL of the external HashiCorp Vault |
| - | features.secrets.externalSecrets.vault.namespace |
String | `` | Optional Vault Enterprise namespace used to access secrets and, by default, authenticate; leave empty if namespaces are not used |
| - | features.secrets.externalSecrets.vault.path |
String | secret |
Vault KV secrets engine mount path |
| - | features.secrets.externalSecrets.vault.version |
String | v2 |
Vault KV secrets engine version |
| - | features.secrets.externalSecrets.vault.caProvider.type |
String | - |
Kubernetes resource type containing the Vault CA certificate: ConfigMap or Secret |
| - | features.secrets.externalSecrets.vault.caProvider.name |
String | - |
Name of the ConfigMap or Secret containing the Vault CA certificate |
| - | features.secrets.externalSecrets.vault.caProvider.key |
String | - |
Key containing the PEM-encoded Vault CA certificate |
| - | features.secrets.externalSecrets.vault.auth.tokenSecretRef.name |
String | - |
Name of the Kubernetes Secret containing the Vault token |
| - | features.secrets.externalSecrets.vault.auth.tokenSecretRef.key |
String | - |
Key in the Kubernetes Secret containing the Vault token |
| - | features.secrets.externalSecrets.vault.auth.appRole.path |
String | - |
Mount path of the AppRole authentication method in Vault |
| - | features.secrets.externalSecrets.vault.auth.appRole.roleId |
String | - |
Vault AppRole RoleID (not a secret) |
| - | features.secrets.externalSecrets.vault.auth.appRole.secretRef.name |
String | - |
Name of the Kubernetes Secret containing the AppRole SecretID |
| - | features.secrets.externalSecrets.vault.auth.appRole.secretRef.key |
String | - |
Key in the Kubernetes Secret containing the AppRole SecretID |
| - | features.secrets.externalSecrets.vault.auth.kubernetes.mountPath |
String | - |
Mount path of the Kubernetes authentication method in Vault |
| - | features.secrets.externalSecrets.vault.auth.kubernetes.role |
String | - |
Vault Kubernetes authentication role |
| - | features.secrets.externalSecrets.vault.auth.kubernetes.serviceAccountRef.name |
String | - |
ServiceAccount name used by ESO to request an authentication token |
| - | features.secrets.externalSecrets.vault.auth.kubernetes.serviceAccountRef.audiences |
List<String> | - |
Optional audiences for the requested ServiceAccount token; they must match the Vault role configuration |
| - | features.secrets.externalSecrets.secrets |
List<ExternalSecretSchema> | [] |
Secrets to synchronize from the external Vault into Kubernetes |
| - | features.secrets.externalSecrets.secrets[].name |
String | `` | Name of the generated ExternalSecret and target Kubernetes Secret |
| - | features.secrets.externalSecrets.secrets[].namespace |
String | `` | Target Kubernetes namespace. It must exist when the ExternalSecret is reconciled and can either be provided beforehand or created through content.namespaces |
| - | features.secrets.externalSecrets.secrets[].remoteKey |
String | `` | Path of the secret inside the configured Vault KV secrets engine |
| - | features.secrets.externalSecrets.secrets[].refreshInterval |
String | `` | Optional interval for ESO to refresh the Kubernetes Secret (for example 15m). If omitted, ESO uses its default interval of 1h |
| - | features.secrets.externalSecrets.secrets[].data |
Map | {} |
Mapping from Kubernetes Secret keys to Vault properties |
--external-secrets-image |
features.secrets.externalSecrets.helm.image |
String | `` | Sets image for external secrets operator |
--external-secrets-certcontroller-image |
features.secrets.externalSecrets.helm.certControllerImage |
String | `` | Sets image for external secrets operator's controller |
--external-secrets-webhook-image |
features.secrets.externalSecrets.helm.webhookImage |
String | `` | Sets image for external secrets operator's webhook |
| - | features.secrets.externalSecrets.helm.values |
Map | {} |
Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration |
| - | features.secrets.externalSecrets.helm.chart |
String | external-secrets |
Name of the Helm chart |
| - | features.secrets.externalSecrets.helm.repoURL |
String | https://charts.external-secrets.io |
Repository url from which the Helm chart should be obtained |
| - | features.secrets.externalSecrets.helm.version |
String | 2.14.0 |
The version of the Helm chart to be installed |
--vault |
features.secrets.vault.mode |
VaultMode | - |
Installs Hashicorp vault and the external secrets operator. Possible values: dev, prod. |
--vault-url |
features.secrets.vault.url |
String | `` | Sets url for vault ui |
| - | features.secrets.vault.oidc.providerName |
String | Keycloak |
Name of the OIDC provider displayed in tool login screens |
| - | features.secrets.vault.oidc.issuerUrl |
String | `` | OIDC issuer URL, for example http://keycloak.local.gd/realms/gop |
| - | features.secrets.vault.oidc.clientId |
String | vault |
OIDC client ID |
| - | features.secrets.vault.oidc.clientSecret |
String | `` | OIDC client secret |
| - | features.secrets.vault.oidc.scopes |
List<String> | [openid, profile, email] |
OIDC scopes requested by the tool |
| - | features.secrets.vault.oidc.adminGroupName |
String | `` | OIDC group that receives full admin permissions in all OIDC-enabled tools |
--vault-image |
features.secrets.vault.helm.image |
String | `` | Sets image for vault |
| - | features.secrets.vault.helm.values |
Map | {} |
Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration |
| - | features.secrets.vault.helm.chart |
String | vault |
Name of the Helm chart |
| - | features.secrets.vault.helm.repoURL |
String | https://helm.releases.hashicorp.com |
Repository url from which the Helm chart should be obtained |
| - | features.secrets.vault.helm.version |
String | 0.34.1 |
The version of the Helm chart to be installed |
--secrets-namespace |
features.secrets.namespace |
String | secrets |
Optional defines the kubernetes namespace for secrets. |
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--ingress |
features.ingress.active |
Boolean | false |
Sets and enables Ingress Controller |
--ingress-image |
features.ingress.helm.image |
String | `` | The image of the Helm chart to be installed |
| - | features.ingress.helm.values |
Map | {} |
Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration |
| - | features.ingress.helm.chart |
String | traefik |
Name of the Helm chart |
| - | features.ingress.helm.repoURL |
String | https://traefik.github.io/charts |
Repository url from which the Helm chart should be obtained |
| - | features.ingress.helm.version |
String | 42.4.1 |
The version of the Helm chart to be installed |
--ingress-namespace |
features.ingress.ingressNamespace |
String | ingress |
Optional defines the kubernetes namespace for Ingress Controller |
| CLI | Config key | Type | Default | Description |
|---|---|---|---|---|
--cert-manager |
features.certManager.active |
Boolean | false |
Sets and enables Cert Manager |
--cert-manager-issuer |
features.certManager.issuer |
String | cluster-selfsigned |
Sets and enables Cert Manager |
--cert-manager-namespace |
features.certManager.namespace |
String | cert-manager |
Optional defines the kubernetes namespace for Cert Manager |
--cert-manager-image |
features.certManager.helm.image |
String | `` | Sets image for Cert Manager |
--cert-manager-webhook-image |
features.certManager.helm.webhookImage |
String | `` | Sets webhook Image for Cert Manager |
--cert-manager-cainjector-image |
features.certManager.helm.cainjectorImage |
String | `` | Sets cainjector Image for Cert Manager |
--cert-manager-acme-solver-image |
features.certManager.helm.acmeSolverImage |
String | `` | Sets acmeSolver Image for Cert Manager |
--cert-manager-startup-api-check-image |
features.certManager.helm.startupAPICheckImage |
String | `` | Sets startupAPICheck Image for Cert Manager |
| - | features.certManager.helm.values |
Map | {} |
Helm values of the chart, allows overriding defaults and setting values that are not exposed as explicit configuration |
| - | features.certManager.helm.chart |
String | cert-manager |
Name of the Helm chart |
| - | features.certManager.helm.repoURL |
String | https://charts.jetstack.io |
Repository url from which the Helm chart should be obtained |
| - | features.certManager.helm.version |
String | v1.21.3 |
The version of the Helm chart to be installed |