Skip to content

Commit ab347bc

Browse files
committed
Add more descriptive gl-oci tool description.
Signed-off-by: Tobias Wolf <[email protected]> On-behalf-of: SAP <[email protected]>
1 parent 831ea0a commit ab347bc

File tree

1 file changed

+13
-10
lines changed

1 file changed

+13
-10
lines changed

src/gardenlinux/oci/__main__.py

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@
1818
@click.group()
1919
def cli() -> None:
2020
"""
21-
gl-oci click argument entrypoint
21+
gl-oci provides functionality to handle OCI containers. It can pull and push
22+
images from remote repositories as well as handle GardenLinux artifacts, OCI
23+
image indices and manifests.
2224
2325
:since: 0.7.0
2426
"""
@@ -182,7 +184,7 @@ def build_container(
182184
)
183185
def load_container(oci_archive: str, additional_tag: List[str]) -> None:
184186
"""
185-
Push to an OCI registry.
187+
Load an OCI archive.
186188
187189
:since: 1.0.0
188190
"""
@@ -208,7 +210,7 @@ def load_container(oci_archive: str, additional_tag: List[str]) -> None:
208210
)
209211
def load_containers_from_directory(directory: str) -> None:
210212
"""
211-
Push to an OCI registry.
213+
Load multiple OCI archives.
212214
213215
:since: 1.0.0
214216
"""
@@ -242,7 +244,7 @@ def load_containers_from_directory(directory: str) -> None:
242244
)
243245
def new_index(index: str, index_tag: str, insecure: bool, additional_tag: List[str]) -> None:
244246
"""
245-
Push a list of files from the `manifest_folder` to an index.
247+
Create a new OCI image index.
246248
247249
:since: 1.0.0
248250
"""
@@ -278,7 +280,7 @@ def new_index(index: str, index_tag: str, insecure: bool, additional_tag: List[s
278280
)
279281
def pull_container(container: str, tag: str, platform: str, insecure: bool) -> None:
280282
"""
281-
Push to an OCI registry.
283+
Pull an OCI image container from a remote OCI registry.
282284
283285
:since: 1.0.0
284286
"""
@@ -311,7 +313,7 @@ def pull_container(container: str, tag: str, platform: str, insecure: bool) -> N
311313
)
312314
def push_container(container: str, tag: str, destination: str, insecure: bool) -> None:
313315
"""
314-
Push to an OCI registry.
316+
Push an OCI image container to a remote OCI registry.
315317
316318
:since: 1.0.0
317319
"""
@@ -466,7 +468,8 @@ def push_manifest(
466468
additional_tag: List[str],
467469
) -> None:
468470
"""
469-
Push artifacts and the manifest from a directory to a registry.
471+
Push to an OCI image container given GardenLinux canonical named artifacts
472+
in a specified directory.
470473
471474
:since: 0.7.0
472475
"""
@@ -538,7 +541,7 @@ def push_manifest_tags(
538541
tag: List[str],
539542
) -> None:
540543
"""
541-
Push artifacts and the manifest from a directory to a registry.
544+
Push tags to an OCI image container for a given GardenLinux canonical named image.
542545
543546
:since: 0.10.0
544547
"""
@@ -567,7 +570,7 @@ def push_manifest_tags(
567570
)
568571
def save_container(container: str, tag: str, oci_archive: str) -> None:
569572
"""
570-
Push to an OCI registry.
573+
Saves a given OCI image container as an OCI archive.
571574
572575
:since: 1.0.0
573576
"""
@@ -597,7 +600,7 @@ def save_container(container: str, tag: str, oci_archive: str) -> None:
597600
)
598601
def tag_container(container: str, tag: str, additional_tag: List[str]) -> None:
599602
"""
600-
Push to an OCI registry.
603+
Adds additional tags to a given OCI image container.
601604
602605
:since: 1.0.0
603606
"""

0 commit comments

Comments
 (0)