Skip to content

Commit 05ae0de

Browse files
author
Leonid Podolinskiy
authored
update chart readme (#8)
1 parent 5a77aaf commit 05ae0de

File tree

2 files changed

+12
-7
lines changed

2 files changed

+12
-7
lines changed

helm-chart/Chart.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ annotations:
3131
shortName: lrja
3232
description: Custom resource describing Lightrun agent version, configuration and deployment that will be patched. Dependend on secret with few Lightrun key
3333
artifacthub.io/crdsExamples: |
34-
apiVersion: agents.lightrun.com/v1beta
34+
- apiVersion: agents.lightrun.com/v1beta
3535
kind: LightrunJavaAgent
3636
metadata:
3737
name: example-cr

helm-chart/README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,26 @@
1-
# lightrun-k8s-operator
1+
# [Lightrun k8s operator](https://github.com/lightrun-platform/lightrun-k8s-operator)
22

33
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
44

5-
A Helm chart for Lightrun k8s operator
5+
## Operator docs
6+
[Github readme](https://github.com/lightrun-platform/lightrun-k8s-operator/tree/main/docs)
67

78
## Requirements
89

910
Kubernetes: `>= 1.19.0`
1011

12+
## Dependencies
1113

12-
[Helm chart](../helm-chart/) is available in repository branch `helm-repo`
14+
Custom Resource of the operator is strictly depends on the secret with `lightrun_key` and `pinned_cert_hash` values
15+
[Example](https://github.com/lightrun-platform/lightrun-k8s-operator/tree/main/examples/lightrunjavaagent.yaml#L56)
16+
17+
## Installation
1318
- Add the repo to your Helm repository list
1419
```sh
1520
helm repo add lightrun-k8s-operator https://lightrun-platform.github.io/lightrun-k8s-operator
1621
```
1722

18-
- Install the Helm chart:
23+
- Install the Helm chart:
1924
> _Using default [values](../helm-chart/values.yaml)_
2025
2126
```sh
@@ -31,13 +36,13 @@ helm install lightrun-k8s-operator/lightrun-k8s-operator -f <values file> -n l
3136
You can find more info [here](https://helm.sh/docs/chart_best_practices/custom_resource_definitions/)
3237

3338

34-
- Uninstall the Helm chart.
39+
## Uninstall
3540
```sh
3641
helm delete lightrun-k8s-operator
3742
```
3843
> `CRDs` will not be deleted due to Helm CRDs limitations. You can learn more about the limitations [here](https://helm.sh/docs/topics/charts/#limitations-on-crds).
3944
40-
### Chart version vs controller version
45+
## Chart version vs controller version
4146
For the sake of simplicity, we are keeping the convention of the same version for both the controller image and the Helm chart. This helps to ensure that controller actions are aligned with CRDs preventing failed resource validation errors.
4247

4348

0 commit comments

Comments
 (0)