Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hiddeco/kargo-advanced-2
https://github.com/hiddeco/kargo-advanced-2
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/hiddeco/kargo-advanced-2
- Owner: hiddeco
- Created: 2024-03-26T16:04:53.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-03-27T10:19:21.000Z (9 months ago)
- Last Synced: 2024-10-14T10:24:27.941Z (3 months ago)
- Language: Shell
- Size: 140 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Kargo Advanced Example
This is a GitOps repository of an Kargo example that showcases advanced Kargo techniques and features.
### Features
* A Warehouse which monitors both a container repository for new images and manifest changes in git
* Eight Stage deploy pipeline
* Auto-promotion enabled for dev environment
* Git + Image tag promotion
* Verification using Analysis
* Argo CD application syncing
* Control flow stage
* Rendered Branches
## Instructions
1. Fork this repo, then clone it locally (from your fork).
2. Run the `personalize.sh` to customize the manifests to use your GitHub username.
```
./personalize.sh
```
3. `git commit` the personalized changes
```
git commit -a -m "personalize manifests"
git push
```
4. Create a guestbook container image repository in your GitHub account.
The easiest way to create a new ghcr.io image repository, is by retagging/pushing an existing image with your github username:
```
docker buildx imagetools create \
ghcr.io/akuity/guestbook:latest \
-t ghcr.io//guestbook:v0.0.1
```
You will now have a `guestbook` container image repository. e.g.:
https://github.com/yourgithubusername/guestbook/pkgs/container/guestbook
5. Change guestbook container image repository to public.
In the GitHub UI, navigate to the "guestbook" container repository, Package settings, and change the visibility of the package to public. This will allow Kargo to monitor this repository for new images, without requiring you to configuring Kargo with container image repository credentials.
6. Download and install the latest CLI from [Kargo Releases](https://github.com/akuity/kargo/releases) and Argo CD:
```
./download-cli.sh /usr/local/bin/kargo
```
7. Login to Kargo
```
kargo login https:// --admin
```
8. Login to Argo CD
```
argocd login
```
8. Apply the Kargo manifests
```
kargo apply -f ./kargo
```
9. Add git repository credentials to Kargo.
```
$ ./add-credential.sh
Configuring credentials for https://github.com/akuity/kargo-advanced.git
Username: yourgithubusername
Password:
```
As part of the promotion process, Kargo requires privileges to commit changes to your git repository, as well as the ability to create pull requests. Ensure that the given token has these privileges.
10. Promtote the image!
You now have a Kargo Pipeline which promotes images from the guestbook container image repository, through a three-stage deploy pipeline. Visit the `kargo-advanced` Project in the Kargo UI to see the deploy pipeline.
To promote, click the target icon to the left of the `dev` Stage, select the detected Freight, and click `Yes` to promote. Once promoted, the freight will be qualified to be promoted to downstream Stages (`staging`, `prod`).
## Simulating a release
To simulate a release, simply retag an image with a newer semantic version. e.g.:
```
docker buildx imagetools create \
ghcr.io/akuity/guestbook:latest \
-t ghcr.io//guestbook:v0.0.2
```
Then refresh the Warehouse in the UI to detect the new Freight.