Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: updating freight aliases #2606

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/docs/15-concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ include one or more:

Freight can therefore be thought of as a sort of meta-artifact. Freight is what
Kargo seeks to progress from one stage to another.
For detailed guidance on how to effectively work with Freight, you can
refer to the [How-to Guide: Working with Freight](https://kargo.akuity.io/how-to-guides/working-with-freight).

### What is a Warehouse?

Expand Down
22 changes: 16 additions & 6 deletions docs/docs/30-how-to-guides/15-working-with-freight.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,12 +112,22 @@ resource as it progresses through the `Stage`s of a pipeline.

This is conveniently accomplished via the Kargo CLI:

```shell
kargo update freight \
f5f87aa23c9e97f43eb83dd63768ee41f5ba3766 \
--alias frozen-tauntaun \
--project kargo-demo
```
1. **Using Name**
```shell
kargo update freight \
--project=kargo-demo \
--name=f5f87aa23c9e97f43eb83dd63768ee41f5ba3766 \
--new-alias=frozen-tauntaun
```

1. **Using Old Alias**:
If you have the old alias and prefer to use it
```shell
kargo update freight \
--project=kargo-demo \
--old-alias=mortal-dragonfly \
--new-alias=frozen-tauntaun
```

This can also be accomplished via `kubectl` commands `apply`, `edit`, `patch`,
etc. by updating the `alias` field of the `Freight` resource.
Expand Down