Skip to content

Commit fa7bf3a

Browse files
authored
docs: prefer oci chart (#3155)
1 parent 5805143 commit fa7bf3a

File tree

4 files changed

+10
-30
lines changed

4 files changed

+10
-30
lines changed

README.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -18,25 +18,18 @@ The general concept is that we track the versions of Kubernetes that are support
1818
- [Azure Kubernetes Service (AKS)](https://endoflife.date/azure-kubernetes-service)
1919
- [Google Kubernetes Engine (GKE)](https://endoflife.date/google-kubernetes-engine)
2020

21-
## Add Helm repository
22-
23-
```bash
24-
helm repo add renovate https://docs.renovatebot.com/helm-charts
25-
helm repo update
26-
```
27-
2821
## Install chart
2922

3023
Using config from a file:
3124

3225
```bash
33-
helm install --generate-name --set-file renovate.config=config.json renovate/renovate
26+
helm install --generate-name --set-file renovate.config=config.json oci://ghcr.io/renovatebot/charts/renovate
3427
```
3528

3629
Using config from a string:
3730

3831
```bash
39-
helm install --generate-name --set renovate.config='\{\"token\":\"...\"\}' renovate/renovate
32+
helm install --generate-name --set renovate.config='\{\"token\":\"...\"\}' oci://ghcr.io/renovatebot/charts/renovate
4033
```
4134

4235
**Note**: `renovate.config` must be a valid Renovate [self-hosted configuration](https://docs.renovatebot.com/self-hosted-configuration/).

charts/renovate/README.md

Lines changed: 4 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,18 @@ Universal dependency update tool that fits into your workflows.
88

99
## Installation
1010

11-
### Add Helm repository
12-
13-
```shell
14-
helm repo add renovate https://docs.renovatebot.com/helm-charts
15-
helm repo update
16-
```
17-
1811
## Install Renovate chart
1912

2013
Using config from a file:
2114

2215
```bash
23-
helm install --generate-name --set-file renovate.config=config.json renovate/renovate
16+
helm install --generate-name --set-file renovate.config=config.json oci://ghcr.io/renovatebot/charts/renovate
2417
```
2518

2619
Using config from a string:
2720

2821
```bash
29-
helm install --generate-name --set renovate.config='\{\"token\":\"...\"\}' renovate/renovate
22+
helm install --generate-name --set renovate.config='\{\"token\":\"...\"\}' oci://ghcr.io/renovatebot/charts/renovate
3023
```
3124

3225
**NOTE**: `renovate.config` must be a valid Renovate [self-hosted configuration](https://docs.renovatebot.com/self-hosted-configuration/)
@@ -80,7 +73,7 @@ The following table lists the configurable parameters of the chart and the defau
8073
| image.registry | string | `"ghcr.io"` | Registry to pull image from |
8174
| image.repository | string | `"renovatebot/renovate"` | Image name to pull |
8275
| image.tag | string | `"41.97.10"` | Renovate image tag to pull |
83-
| image.useFull | bool | `false` | Set `true` to use the full image. See https://docs.renovatebot.com/getting-started/running/#the-full-image |
76+
| image.useFull | bool | `false` | Set `true` to use the full image. See <https://docs.renovatebot.com/getting-started/running/#the-full-image> |
8477
| imagePullSecrets | object | `{}` | Secret to use to pull the image from the repository |
8578
| nameOverride | string | `""` | Override the name of the chart |
8679
| nodeSelector | object | `{}` | Select the node using labels to specify where the cronjob pod should run on |
@@ -125,7 +118,7 @@ can make use of the cache that have been build up in previous runs. Set `renovat
125118
to enable this. If necessary, the storageClass can be configured and the storageSize can be set to the preferred value.
126119

127120
**HINT**: It is highly recommended to use the redis subchart or SQLite for caching, instead of disk caching.
128-
Take a look at https://github.com/renovatebot/renovate/discussions/30525 for more information.
121+
Take a look at <https://github.com/renovatebot/renovate/discussions/30525> for more information.
129122

130123
## Renovate config templating
131124

charts/renovate/README.md.gotmpl

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,25 +9,19 @@
99

1010
## Installation
1111

12-
### Add Helm repository
13-
14-
```shell
15-
helm repo add renovate https://docs.renovatebot.com/helm-charts
16-
helm repo update
17-
```
1812

1913
## Install Renovate chart
2014

2115
Using config from a file:
2216

2317
```bash
24-
helm install --generate-name --set-file renovate.config=config.json renovate/renovate
18+
helm install --generate-name --set-file renovate.config=config.json oci://ghcr.io/renovatebot/charts/renovate
2519
```
2620

2721
Using config from a string:
2822

2923
```bash
30-
helm install --generate-name --set renovate.config='\{\"token\":\"...\"\}' renovate/renovate
24+
helm install --generate-name --set renovate.config='\{\"token\":\"...\"\}' oci://ghcr.io/renovatebot/charts/renovate
3125
```
3226

3327
**NOTE**: `renovate.config` must be a valid Renovate [self-hosted configuration](https://docs.renovatebot.com/self-hosted-configuration/)
@@ -45,7 +39,7 @@ can make use of the cache that have been build up in previous runs. Set `renovat
4539
to enable this. If necessary, the storageClass can be configured and the storageSize can be set to the preferred value.
4640

4741
**HINT**: It is highly recommended to use the redis subchart or SQLite for caching, instead of disk caching.
48-
Take a look at https://github.com/renovatebot/renovate/discussions/30525 for more information.
42+
Take a look at <https://github.com/renovatebot/renovate/discussions/30525> for more information.
4943

5044
## Renovate config templating
5145

charts/renovate/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ image:
8686
tag: 41.97.10
8787
# -- "IfNotPresent" to pull the image if no image with the specified tag exists on the node, "Always" to always pull the image or "Never" to try and use pre-pulled images
8888
pullPolicy: IfNotPresent
89-
# -- Set `true` to use the full image. See https://docs.renovatebot.com/getting-started/running/#the-full-image
89+
# -- Set `true` to use the full image. See <https://docs.renovatebot.com/getting-started/running/#the-full-image>
9090
useFull: false
9191

9292
# -- Secret to use to pull the image from the repository

0 commit comments

Comments
 (0)