-
Notifications
You must be signed in to change notification settings - Fork 149
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs to use Helm chart from OCI registry (#3565)
**What this PR does / why we need it**: **Which issue(s) this PR fixes**: Fixes # **Does this PR introduce a user-facing change?**: <!-- If no, just write "NONE" in the release-note block below. --> ```release-note NONE ``` This PR was merged by Kapetanios.
- Loading branch information
Showing
3 changed files
with
21 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,13 +19,6 @@ description: > | |
## In the cluster-wide mode | ||
This way requires installing cluster-level resources. Piped installed with this way can perform deployment workloads against any other namespaces than the where Piped runs on. | ||
|
||
- Adding `pipecd` helm chart repository | ||
|
||
``` | ||
helm repo add pipecd https://charts.pipecd.dev | ||
helm repo update | ||
``` | ||
|
||
- Preparing a piped configuration file as the following | ||
|
||
``` yaml | ||
|
@@ -46,15 +39,15 @@ This way requires installing cluster-level resources. Piped installed with this | |
syncInterval: 1m | ||
``` | ||
- Installing by using `Helm 3` | ||
- Installing by using [Helm](https://helm.sh/docs/intro/install/) (3.8.0 or later) | ||
{{< tabpane >}} | ||
{{< tab lang="bash" header="Piped" >}} | ||
# This command just installs a Piped with the specified version. | ||
# Whenever you want to upgrade that Piped to a new version or update its config data | ||
# you have to restart it by re-running this command. | ||
helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
helm upgrade -i dev-piped oci://ghcr.io/pipe-cd/chart/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
--set-file config.data={PATH_TO_PIPED_CONFIG_FILE} \ | ||
--set-file secret.data.piped-key={PATH_TO_PIPED_KEY_FILE} \ | ||
--set-file secret.data.ssh-key={PATH_TO_PRIVATE_SSH_KEY_FILE} | ||
|
@@ -65,7 +58,7 @@ helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} - | |
# This allows upgrading Piped to a new version from the web console. | ||
# But we still need to restart Piped when we want to update its config data. | ||
helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
helm upgrade -i dev-piped oci://ghcr.io/pipe-cd/chart/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
--set launcher.enabled=true \ | ||
--set-file config.data={PATH_TO_PIPED_CONFIG_FILE} \ | ||
--set-file secret.data.piped-key={PATH_TO_PIPED_KEY_FILE} \ | ||
|
@@ -78,7 +71,7 @@ helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} - | |
# remote-config allows loading the Piped config stored in a remote location such as a Git repository. | ||
# Whenever the config data is changed, it loads the new config and restarts Piped to use that new config. | ||
helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
helm upgrade -i dev-piped oci://ghcr.io/pipe-cd/chart/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
--set launcher.enabled=true \ | ||
--set launcher.configFromGitRepo.enabled=true \ | ||
--set [email protected]:{GIT_ORG}/{GIT_REPO}.git \ | ||
|
@@ -125,15 +118,15 @@ Most parts are identical to the previous way, but some are slightly different. | |
namespace: {NAMESPACE} | ||
``` | ||
|
||
- Installing by using `Helm 3` | ||
- Installing by using [Helm](https://helm.sh/docs/intro/install/) (3.8.0 or later) | ||
|
||
{{< tabpane >}} | ||
{{< tab lang="bash" header="Piped" >}} | ||
# This command just installs a Piped with the specified version. | ||
# Whenever you want to upgrade that Piped to a new version or update its config data | ||
# you have to restart it by re-running this command. | ||
|
||
helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
helm upgrade -i dev-piped oci://ghcr.io/pipe-cd/chart/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
--set-file config.data={PATH_TO_PIPED_CONFIG_FILE} \ | ||
--set-file secret.data.piped-key={PATH_TO_PIPED_KEY_FILE} \ | ||
--set-file secret.data.ssh-key={PATH_TO_PRIVATE_SSH_KEY_FILE} \ | ||
|
@@ -146,7 +139,7 @@ helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} - | |
# This allows upgrading Piped to a new version from the web console. | ||
# But we still need to restart Piped when we want to update its config data. | ||
|
||
helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
helm upgrade -i dev-piped oci://ghcr.io/pipe-cd/chart/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
--set launcher.enabled=true \ | ||
--set-file config.data={PATH_TO_PIPED_CONFIG_FILE} \ | ||
--set-file secret.data.piped-key={PATH_TO_PIPED_KEY_FILE} \ | ||
|
@@ -161,7 +154,7 @@ helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} - | |
# remote-config allows loading the Piped config stored in a remote location such as a Git repository. | ||
# Whenever the config data is changed, it loads the new config and restarts Piped to use that new config. | ||
|
||
helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
helm upgrade -i dev-piped oci://ghcr.io/pipe-cd/chart/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
--set launcher.enabled=true \ | ||
--set launcher.configFromGitRepo.enabled=true \ | ||
--set [email protected]:{GIT_ORG}/{GIT_REPO}.git \ | ||
|
@@ -182,15 +175,15 @@ Starting from OpenShift 4.2, it also inserts that user into `/etc/passwd` for us | |
but before that version, the assigned user is missing in that file. That blocks workloads of `gcr.io/pipecd/piped` image. | ||
Therefore if you are running on OpenShift with a version before 4.2, please use `gcr.io/pipecd/piped-okd` image with the following command: | ||
|
||
- Installing by using `Helm 3` | ||
- Installing by using [Helm](https://helm.sh/docs/intro/install/) (3.8.0 or later) | ||
|
||
{{< tabpane >}} | ||
{{< tab lang="bash" header="Piped" >}} | ||
# This command just installs a Piped with the specified version. | ||
# Whenever you want to upgrade that Piped to a new version or update its config data | ||
# you have to restart it by re-running this command. | ||
|
||
helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
helm upgrade -i dev-piped oci://ghcr.io/pipe-cd/chart/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
--set-file config.data={PATH_TO_PIPED_CONFIG_FILE} \ | ||
--set-file secret.data.piped-key={PATH_TO_PIPED_KEY_FILE} \ | ||
--set-file secret.data.ssh-key={PATH_TO_PRIVATE_SSH_KEY_FILE} \ | ||
|
@@ -209,7 +202,7 @@ helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} - | |
# This allows upgrading Piped to a new version from the web console. | ||
# But we still need to restart Piped when we want to update its config data. | ||
|
||
helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
helm upgrade -i dev-piped oci://ghcr.io/pipe-cd/chart/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
--set launcher.enabled=true \ | ||
--set-file config.data={PATH_TO_PIPED_CONFIG_FILE} \ | ||
--set-file secret.data.piped-key={PATH_TO_PIPED_KEY_FILE} \ | ||
|
@@ -230,7 +223,7 @@ helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} - | |
# remote-config allows loading the Piped config stored in a remote location such as a Git repository. | ||
# Whenever the config data is changed, it loads the new config and restarts Piped to use that new config. | ||
|
||
helm upgrade -i dev-piped pipecd/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
helm upgrade -i dev-piped oci://ghcr.io/pipe-cd/chart/piped --version={{< blocks/latest_version >}} --namespace={NAMESPACE} \ | ||
--set launcher.enabled=true \ | ||
--set launcher.configFromGitRepo.enabled=true \ | ||
--set [email protected]:{GIT_ORG}/{GIT_REPO}.git \ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters