Skip to content

Commit c45157a

Browse files
committed
Add kcp-operator to repository README and extend Chart README
On-behalf-of: SAP <[email protected]> Signed-off-by: Marvin Beckers <[email protected]>
1 parent 04dfab9 commit c45157a

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ The following charts are currently available from this repository:
88

99
- [kcp](./charts/kcp/)
1010
- [api-syncagent](./charts/api-syncagent/)
11+
- [kcp-operator](./charts/kcp-operator/)
1112

1213
> [!CAUTION]
1314
> The charts below are work-in-progress and currently not ready for production use.
@@ -20,7 +21,6 @@ that are meant to be used together:
2021
- [proxy](./charts/proxy/)
2122
- [cache](./charts/cache/)
2223

23-
2424
## Usage
2525

2626
[Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's

charts/kcp-operator/README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,33 @@
11
# KCP Helm Chart - kcp-operator
22

33
This Helm chart deploys an instance of the [kcp-operator](https://github.com/kcp-dev/kcp-operator).
4-
For more documentation, check out [docs.kcp.io/kcp-operator](https://docs.kcp.io/kcp-operator).
4+
5+
## Requirements
6+
7+
* [cert-manager](https://cert-manager.io/docs/installation)
8+
9+
## Usage
10+
11+
[Helm](https://helm.sh) must be installed to use the charts. Please refer to Helm's
12+
[documentation](https://helm.sh/docs) to get started.
13+
14+
Once Helm has been set up correctly, add the repo as follows:
15+
16+
helm repo add kcp https://kcp-dev.github.io/helm-charts
17+
18+
If you had already added this repo earlier, run `helm repo update` to retrieve the latest versions
19+
of the packages. You can then run `helm search repo kcp` to see the charts.
20+
21+
To install the kcp-operator chart (you can also pass custom values via `--values myvalues.yaml`):
22+
23+
helm install my-kcp-operator kcp/kcp-operator
24+
25+
To uninstall the chart:
26+
27+
helm delete my-kcp-operator
528

629
Check [values.yaml](./values.yaml) for configuration options for this Helm chart.
30+
31+
## Documentation
32+
33+
For documentation on how to use kcp-operator, check out [docs.kcp.io/kcp-operator](https://docs.kcp.io/kcp-operator).

0 commit comments

Comments
 (0)