Skip to content

Commit b69bd2a

Browse files
committed
feat: Add usage documentation for gitops templates and remove obsolete command and parameter files
1 parent e419e09 commit b69bd2a

File tree

6 files changed

+58
-101
lines changed

6 files changed

+58
-101
lines changed

docs/Usage.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Usage
2+
3+
The gitops templates are built into one ocm component which is called `gitops-templates`.
4+
5+
You can fetch it from the ocm repo: `ghcr.io/openmcp-project/components`.
6+
The component name is: `github.com/openmcp-project/gitops-templates`.
7+
8+
To get a list of all resources, run the ocm cli:
9+
10+
```bash
11+
> ocm get resources --repo OCIRegistry::ghcr.io/openmcp-project/components github.com/openmcp-project/gitops-templates:0.0.1
12+
13+
NAME VERSION IDENTITY TYPE RELATION
14+
fluxcd v0.0.1 fileSystem local
15+
gitops-templates v0.0.1 blob external
16+
openmcp v0.0.1 fileSystem local
17+
openmcp-operator v0.0.1 ociImage local
18+
```
19+
20+
The templates itself are fileSystem types. You can fetch these using:
21+
22+
```bash
23+
# Just openmcp
24+
> ocm download resources --downloader ocm/dirtree --repo OCIRegistry::ghcr.io/openmcp-project/components github.com/openmcp-project/gitops-templates:v0.0.1 openmcp
25+
26+
# Openmcp and fluxcd
27+
> ocm download resources --downloader ocm/dirtree --repo OCIRegistry::ghcr.io/openmcp-project/components github.com/openmcp-project/gitops-templates:v0.0.1 openmcp fluxcd
28+
```
29+
30+
If you specify multiple templates, they will be put into a directory structure in the directory you are currently in:
31+
32+
```txt
33+
github.com/
34+
openmcp-project/
35+
gitops-templates/
36+
v0.0.1/
37+
openmcp/
38+
fluxcd/
39+
```
40+
41+
## Rendering a template
42+
43+
To render a template you can use helm, but you can also use our bootstrapper cli.
44+
45+
To use helm first create a values.yaml:
46+
47+
```yaml
48+
# values.yaml
49+
openmcpOperator:
50+
image: ghcr.io/openmcp-project/images/openmcp-operator
51+
tag: v0.9.1
52+
53+
platformClusterKubeconfigSecretName: "platform-kubeconfig"
54+
```
55+
56+
```bash
57+
> helm template --output-dir output --values values.yaml github.com/openmcp-project/gitops-templates/v0.0.1/openmcp
58+
```

docs/commands.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

docs/parameters.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

script/go.mod

Lines changed: 0 additions & 11 deletions
This file was deleted.

script/go.sum

Lines changed: 0 additions & 17 deletions
This file was deleted.

script/main.go

Lines changed: 0 additions & 59 deletions
This file was deleted.

0 commit comments

Comments
 (0)