Networking/ccl
1
0
Fork 0
mirror of https://gitea.elkins.co/Networking/ccl.git synced 2025-02-04 12:02:47 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update README to describe the disabled category

Browse Source
This commit is contained in:
Joel Elkins 2022-07-27 21:56:57 -05:00
parent 6efca69f66
commit 43df4e42be
No known key found for this signature in database
GPG Key ID: 133589DC38921AE2
1 changed files with 23 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -44,6 +44,15 @@ doing so allows you to do operations on multiple containers as a group (e.g.
starting, stopping, updating). This concept is distinct to `ccl` and is not
recognized or available to podman itself.
Two Categories are treated specially:
- `disabled` indicates that containers identified here are to be excluded
normally, unless specifically requested by name. This exclusion can be disabled
(i.e. disabled containers included in the action) by specifying the `-a` option.
- `all` is an implicit category to match all containers (except disabled ones
by default, as described above).
<details>
<summary>Expand for example</summary>
@ -116,7 +125,7 @@ ipv6_address = "2001:db8:0:6::1:15"
This tool uses the [cobra](https://github.com/spf13/cobra) library, which
provides a convenient completion configurator for various shells. Refer to the
[cobra documentation](https://github.com/spf13/cobra/blob/main/shell_completions.md)
for info on how to use.
for info on how to use this feature.
## Usage
@ -126,19 +135,19 @@ intersecting the command arguments, and iterate the verb over each of them. If
no arguments are provided, it is the same as "all". Invalid (unmatched)
container names are silently ignored.
| Command/Verb | Description |
|--------------|--------------------------------------------------------------------------|
| create | Create the configured containers |
| ls | List some basic info about the containers |
| show | Output a [toml][] formatted configuration |
| start | Start containers. Do nothing for any container already running |
| restart | Stop then start containers |
| update | Pull updated images, tear down the configured container, and recreate it |
| pull | Just pull the configured image. Defined containers unaffected |
| recreate | Stop, tear down, create, and restart containers |
| rm | Same as `podman rm --force` |
| stop | Stop containers |
| completion | Generate a completion script for fish, zsh, or bash |
| Command/Verb | Description |
|--------------|----------------------------------------------------------------------------------------|
| create | Create the configured containers |
| ls | List some basic info about the containers |
| show | Output a [toml][] formatted configuration |
| start | Start containers. Do nothing for any container already running |
| restart | Stop then start containers |
| update | Pull updated images, tear down the configured container, and recreate it |
| pull | Just pull the configured image. Defined containers unaffected |
| recreate | Stop, tear down, create, and restart containers (does not pull unless image not found) |
| rm | Same as `podman rm --force` |
| stop | Stop containers |
| completion | Generate a completion script for fish, zsh, or bash |
Refer to `ccl help` for more info.