Skip to content

Commit ba4cfd4

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 3655fc7 commit ba4cfd4

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

src/gardenlinux/oci/__main__.py

Lines changed: 14 additions & 11 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
"""
@@ -77,7 +79,7 @@ def add_container_to_index(
7779

7880
manifest = manifest_container.read_manifest()
7981

80-
index_resource = Container(index, insecure=insecure)
82+
index_resource = Container(f"{index}:{index_tag}", insecure=insecure)
8183

8284
image_index = index_resource.read_or_generate_index()
8385
image_index.append_manifest(manifest)
@@ -187,7 +189,7 @@ def build_container(
187189
)
188190
def load_container(oci_archive: str, additional_tag: List[str]) -> None:
189191
"""
190-
Push to an OCI registry.
192+
Load an OCI archive.
191193
192194
:since: 1.0.0
193195
"""
@@ -213,7 +215,7 @@ def load_container(oci_archive: str, additional_tag: List[str]) -> None:
213215
)
214216
def load_containers_from_directory(directory: str) -> None:
215217
"""
216-
Push to an OCI registry.
218+
Load multiple OCI archives.
217219
218220
:since: 1.0.0
219221
"""
@@ -249,7 +251,7 @@ def new_index(
249251
index: str, index_tag: str, insecure: bool, additional_tag: List[str]
250252
) -> None:
251253
"""
252-
Push a list of files from the `manifest_folder` to an index.
254+
Create a new OCI image index.
253255
254256
:since: 1.0.0
255257
"""
@@ -285,7 +287,7 @@ def new_index(
285287
)
286288
def pull_container(container: str, tag: str, platform: str, insecure: bool) -> None:
287289
"""
288-
Push to an OCI registry.
290+
Pull an OCI image container from a remote OCI registry.
289291
290292
:since: 1.0.0
291293
"""
@@ -318,7 +320,7 @@ def pull_container(container: str, tag: str, platform: str, insecure: bool) -> N
318320
)
319321
def push_container(container: str, tag: str, destination: str, insecure: bool) -> None:
320322
"""
321-
Push to an OCI registry.
323+
Push an OCI image container to a remote OCI registry.
322324
323325
:since: 1.0.0
324326
"""
@@ -473,7 +475,8 @@ def push_manifest(
473475
additional_tag: List[str],
474476
) -> None:
475477
"""
476-
Push artifacts and the manifest from a directory to a registry.
478+
Push to an OCI image container given GardenLinux canonical named artifacts
479+
in a specified directory.
477480
478481
:since: 0.7.0
479482
"""
@@ -545,7 +548,7 @@ def push_manifest_tags(
545548
tag: List[str],
546549
) -> None:
547550
"""
548-
Push artifacts and the manifest from a directory to a registry.
551+
Push tags to an OCI image container for a given GardenLinux canonical named image.
549552
550553
:since: 0.10.0
551554
"""
@@ -574,7 +577,7 @@ def push_manifest_tags(
574577
)
575578
def save_container(container: str, tag: str, oci_archive: str) -> None:
576579
"""
577-
Push to an OCI registry.
580+
Saves a given OCI image container as an OCI archive.
578581
579582
:since: 1.0.0
580583
"""
@@ -604,7 +607,7 @@ def save_container(container: str, tag: str, oci_archive: str) -> None:
604607
)
605608
def tag_container(container: str, tag: str, additional_tag: List[str]) -> None:
606609
"""
607-
Push to an OCI registry.
610+
Adds additional tags to a given OCI image container.
608611
609612
:since: 1.0.0
610613
"""

0 commit comments

Comments
 (0)