generated from ansible-community/project-template
-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Port content from gh-pages branch of awx-operator
- Loading branch information
Showing
4 changed files
with
613 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
/charts | ||
/bin | ||
/.cr-release-packages |
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 |
---|---|---|
@@ -0,0 +1,62 @@ | ||
# Debugging Helm Chart Release issues | ||
|
||
This doc is mainly focused on debugging release automation issues involving helm charts. | ||
|
||
|
||
### Useful commands for debugging helm chart issues: | ||
|
||
Check if helm charts are installed and delete if needed | ||
|
||
``` | ||
$ helm list | ||
$ helm uninstall awx-operator | ||
``` | ||
|
||
Add awx-operator helm repo, update and list available charts | ||
|
||
``` | ||
$ helm repo add awx-operator https://ansible.github.io/awx-operator/ | ||
$ helm repo update | ||
$ helm search repo awx-operator -l | ||
``` | ||
|
||
Install a specific awx-operator helm chart version in a specific namespace | ||
|
||
``` | ||
helm install my-awx-operator awx-operator/awx-operator -n awx --create-namespace -f my-values.yml --version 1.3.0 | ||
``` | ||
|
||
### Running helm-release playbook | ||
|
||
If the helm release automation fails, sometimes it may be necessary to re-run and debug the release playbook. Here is how to run it: | ||
|
||
``` | ||
ansible-playbook ansible/helm-release.yml -v \ | ||
-e operator_image=quay.io/ansible/awx-operator \ | ||
-e chart_owner=ansible \ | ||
-e tag=1.3.0 \ | ||
-e gh_token=$GH_TOKEN \ | ||
-e gh_user=rooftopcellist | ||
``` | ||
|
||
If you need to replace an existing asset, you need to first delete the existing one. This can be done with the GitHub API: | ||
|
||
``` | ||
# Find the ASSET_ID by querying the API for that release | ||
export RELEASE=1.3.0 | ||
curl -L \ | ||
-H "Accept: application/vnd.github+json" \ | ||
-H "Authorization: Bearer $GH_TOKEN"\ | ||
-H "X-GitHub-Api-Version: 2022-11-28" \ | ||
https://api.github.com/repos/ansible/awx-operator/releases/$RELEASE/assets | ||
# With the ASSET_ID from the previous step, you can now delete the existing release asset | ||
export ASSET_ID=98285xxx | ||
curl -L \ | ||
-X DELETE \ | ||
-H "Accept: application/vnd.github+json" \ | ||
-H "Authorization: Bearer $GH_TOKEN"\ | ||
-H "X-GitHub-Api-Version: 2022-11-28" \ | ||
https://api.github.com/repos/ansible/awx-operator/releases/assets/$ASSET_ID | ||
``` |
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 |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# awx-operator Helm charts | ||
|
||
## Usage | ||
|
||
[Helm](https://helm.sh) must be installed to use the charts. Please refer to | ||
Helm's [documentation](https://helm.sh/docs) to get started. | ||
|
||
Once Helm has been set up correctly, add the repo as follows: | ||
|
||
```bash | ||
helm repo add awx-operator https://ansible.github.io/awx-operator/ | ||
``` | ||
|
||
If you had already added this repo earlier, run `helm repo update` to retrieve | ||
the latest versions of the packages. You can then run `helm search repo | ||
awx-operator` to see the charts. | ||
|
||
To install the `awx-operator` chart: | ||
|
||
```bash | ||
helm install my-awx-operator awx-operator/awx-operator | ||
``` | ||
|
||
To install a specific awx-operator helm chart version in a specific namespace: | ||
|
||
``` | ||
helm install my-awx-operator awx-operator/awx-operator -n awx --create-namespace -f my-values.yml --version 1.3.0 | ||
``` | ||
|
||
To uninstall the chart: | ||
|
||
```bash | ||
helm delete my-awx-operator | ||
``` |
Oops, something went wrong.