Skip to content

Commit

Permalink
Add some documentation of the values
Browse files Browse the repository at this point in the history
  • Loading branch information
mbaldessari committed Sep 23, 2024
1 parent 0c7c019 commit eef9153
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 13 deletions.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,39 @@
# Update CRD
# pattern-install

![Version: 0.0.2](https://img.shields.io/badge/Version-0.0.2-informational?style=flat-square)

A Helm chart to build and deploy a Cloud Pattern via the patterns operator

## Values

| Key | Type | Default | Description |
|-----|------|---------|-------------|
| global.extraValueFiles | list | `[]` | List of additional value files to be passed to the pattern |
| main | object | `{"clusterGroupName":"default","experimentalCapabilities":"","git":{"repoURL":"https://github.com/pattern-clone/mypattern","repoUpstreamURL":null,"revision":"main"},"gitops":{"channel":"gitops-1.13","operatorSource":"redhat-operators"},"multiSourceConfig":{"clusterGroupChartVersion":null,"enabled":false,"helmRepoUrl":null},"patternsOperator":{"channel":"fast","installPlanApproval":"Automatic","source":"community-operators","sourceNamespace":"openshift-marketplace","startingCSV":null},"tokenSecret":null,"tokenSecretNamespace":null}` | main is used primarly for initial bootstrap pattern configuration |
| main.clusterGroupName | string | `"default"` | Name of the clusterGroup to be used. Drives the clusterGroup chart |
| main.experimentalCapabilities | string | `""` | String to enable certain experimental capabilities in the operator and the framework. Not needed unless you know exactly what you're doing. |
| main.git | object | `{"repoURL":"https://github.com/pattern-clone/mypattern","repoUpstreamURL":null,"revision":"main"}` | Settings related to the git repository used to deploy the pattern |
| main.git.repoURL | string | `"https://github.com/pattern-clone/mypattern"` | Repository URL pointing to the pattern |
| main.git.repoUpstreamURL | string | `nil` | Setting this field will make it so that an in-cluster gitea instance will be spawned. `repoURL` will be ignored and the pattern will be deployed using the in-gitea URL |
| main.git.revision | string | `"main"` | The branch or git reference to use to deploy the pattern |
| main.gitops | object | `{"channel":"gitops-1.13","operatorSource":"redhat-operators"}` | Settings related to the gitops operator |
| main.gitops.channel | string | `"gitops-1.13"` | Default channel to install the gitops operator from |
| main.gitops.operatorSource | string | `"redhat-operators"` | Source to be used to install the gitops operator from |
| main.multiSourceConfig.clusterGroupChartVersion | string | `nil` | The clustergroup chart version to be used when deploying a pattern (defaults to 0.8.*) |
| main.multiSourceConfig.enabled | bool | `false` | Enables a multisource configuration for the clustergroup chart |
| main.multiSourceConfig.helmRepoUrl | string | `nil` | The URL of the VP helm charts repository (defaults to https://charts.validatedpatterns.io) |
| main.patternsOperator.channel | string | `"fast"` | channel name to install the patterns operator from |
| main.patternsOperator.installPlanApproval | string | `"Automatic"` | Installation plan approval of the patterns operator |
| main.patternsOperator.source | string | `"community-operators"` | Source to be used to install the patterns operator from |
| main.patternsOperator.sourceNamespace | string | `"openshift-marketplace"` | Source namespace to install the patterns operator from |
| main.patternsOperator.startingCSV | string | `nil` | Starting CSV for the install of the patterns operator |
| main.tokenSecret | string | `nil` | Name of the secret containing access credentials to clone the git repo to deploy the pattern See https://validatedpatterns.io/blog/2023-12-20-private-repos/ for more information |
| main.tokenSecretNamespace | string | `nil` | Namespace where the above secret will be |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

## Update CRD

In order to update the CRD, copy the following file from the last released
patterns operator version:
Expand Down
27 changes: 27 additions & 0 deletions README.md.gotmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{{ template "chart.header" . }}
{{ template "chart.deprecationWarning" . }}

{{ template "chart.badgesSection" . }}

{{ template "chart.description" . }}

{{ template "chart.homepageLine" . }}

{{ template "chart.maintainersSection" . }}

{{ template "chart.sourcesSection" . }}

{{ template "chart.requirementsSection" . }}

{{ template "chart.valuesSection" . }}

{{ template "helm-docs.versionFooter" . }}

## Update CRD

In order to update the CRD, copy the following file from the last released
patterns operator version:

```sh
cp -v patterns-operator/config/crd/bases/gitops.hybrid-cloud-patterns.io_patterns.yaml ./crds/
```
42 changes: 30 additions & 12 deletions values.yaml
Original file line number Diff line number Diff line change
@@ -1,39 +1,57 @@
global:
# -- List of additional value files to be passed to the pattern
extraValueFiles: []

# -- main is used primarly for initial bootstrap pattern configuration
main:
# -- Settings related to the git repository used to deploy the pattern
git:
# Uncommenting this will set the `originRepo` with the below value
# when `originRepo` is set, an in-cluster gitea will automatically be spawned.
# In this case `originRepo` will point to the upstream repository and `targetRepo`
# will point to the internal in-cluster gitea mirror
# repoUpstreamURL: https://github.com/validatedpatterns/multicloud-gitops
# -- Repository URL pointing to the pattern
repoURL: https://github.com/pattern-clone/mypattern
# -- The branch or git reference to use to deploy the pattern
revision: main
# -- Setting this field will make it so that an in-cluster gitea instance
# will be spawned. `repoURL` will be ignored and the pattern will be deployed
# using the in-gitea URL
repoUpstreamURL: null

# -- Settings related to the gitops operator
gitops:
# -- Default channel to install the gitops operator from
channel: "gitops-1.13"
# -- Source to be used to install the gitops operator from
operatorSource: redhat-operators

# Settings related to the multi source configuration of patterns
multiSourceConfig:
# -- Enables a multisource configuration for the clustergroup chart
enabled: false
# helmRepoUrl: registry.internal.network/helm
# clusterGroupChartVersion: 0.8.*
# -- The URL of the VP helm charts repository (defaults to https://charts.validatedpatterns.io)
helmRepoUrl: null
# -- The clustergroup chart version to be used when deploying a pattern (defaults to 0.8.*)
clusterGroupChartVersion: null

# String to enable certain experimental capabilities in the operator and the
# -- String to enable certain experimental capabilities in the operator and the
# framework. Not needed unless you know exactly what you're doing.
experimentalCapabilities: ""

patternsOperator:
# -- channel name to install the patterns operator from
channel: fast
# -- Source to be used to install the patterns operator from
source: community-operators
# -- Installation plan approval of the patterns operator
installPlanApproval: Automatic
# -- Source namespace to install the patterns operator from
sourceNamespace: openshift-marketplace
# -- Starting CSV for the install of the patterns operator
startingCSV: null

# -- Name of the clusterGroup to be used. Drives the clusterGroup chart
clusterGroupName: default

# If you are using a private repository define the secret where
# credentials to access the private repository are
# tokenSecret:
# tokenSecretNamespace:
# -- Name of the secret containing access credentials to clone the git repo to deploy the pattern
# See https://validatedpatterns.io/blog/2023-12-20-private-repos/ for more information
tokenSecret: null
# -- Namespace where the above secret will be
tokenSecretNamespace: null

0 comments on commit eef9153

Please sign in to comment.