Skip to content

Commit

Permalink
Update SOCI rebuild DB CLI help text and doc
Browse files Browse the repository at this point in the history
Removes rpull command reference from help text which support has been
removed. Aligns help text in CLI and documentation to match.

Signed-off-by: Austin Vazquez <macedonv@amazon.com>
  • Loading branch information
austinvazquez authored and Kern-- committed Jun 6, 2024
1 parent 95695e2 commit 99fc201
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
8 changes: 7 additions & 1 deletion cmd/soci/commands/rebuild_db.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,13 @@ import (

var RebuildDBCommand = cli.Command{
Name: "rebuild-db",
Usage: `rebuild the artifacts database. You should use this command after "rpull" so that indices/ztocs can be discovered by commands like "soci index list", and after "index rm" when using the containerd content store so that deleted orphaned zTOCs will be forgotten`,
Usage: "rebuilds the artifacts database",
UsageText: `
soci [global options] rebuild-db
Use after pulling an image to discover SOCI indices/ztocs or after "index rm"
when using the containerd content store to clear the database of removed zTOCs.
`,
Action: func(cliContext *cli.Context) error {
client, ctx, cancel, err := internal.NewClient(cliContext)
if err != nil {
Expand Down
3 changes: 2 additions & 1 deletion docs/cli-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,8 @@ soci push public.ecr.aws/soci-workshop-examples/ffmpeg:latest
```

### soci rebuild_db
Use this command after image pull so that indices/ztocs can be discovered by commands like "```soci index list```", and after "```index rm```" when using the containerd content store so that deleted orphaned zTOCs will be forgotten
Use after pulling an image to discover SOCI indices/ztocs or after "```index rm```"
when using the containerd content store to clear the database of removed zTOCs.

**Example:**
```
Expand Down

0 comments on commit 99fc201

Please sign in to comment.