1818@click .group ()
1919def 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 """
@@ -177,7 +179,7 @@ def build_container(
177179)
178180def load_container (oci_archive : str , additional_tag : List [str ]) -> None :
179181 """
180- Push to an OCI registry .
182+ Load an OCI archive .
181183
182184 :since: 1.0.0
183185 """
@@ -203,7 +205,7 @@ def load_container(oci_archive: str, additional_tag: List[str]) -> None:
203205)
204206def load_containers_from_directory (directory : str ) -> None :
205207 """
206- Push to an OCI registry .
208+ Load multiple OCI archives .
207209
208210 :since: 1.0.0
209211 """
@@ -232,7 +234,7 @@ def load_containers_from_directory(directory: str) -> None:
232234)
233235def new_index (index : str , insecure : bool , additional_tag : List [str ]) -> None :
234236 """
235- Push a list of files from the `manifest_folder` to an index.
237+ Create a new OCI image index.
236238
237239 :since: 1.0.0
238240 """
@@ -267,7 +269,7 @@ def new_index(index: str, insecure: bool, additional_tag: List[str]) -> None:
267269)
268270def pull_container (container : str , tag : str , platform : str , insecure : bool ) -> None :
269271 """
270- Push to an OCI registry.
272+ Pull an OCI image container from a remote OCI registry.
271273
272274 :since: 1.0.0
273275 """
@@ -300,7 +302,7 @@ def pull_container(container: str, tag: str, platform: str, insecure: bool) -> N
300302)
301303def push_container (container : str , tag : str , destination : str , insecure : bool ) -> None :
302304 """
303- Push to an OCI registry.
305+ Push an OCI image container to a remote OCI registry.
304306
305307 :since: 1.0.0
306308 """
@@ -376,7 +378,8 @@ def push_manifest(
376378 additional_tag : List [str ],
377379) -> None :
378380 """
379- Push artifacts and the manifest from a directory to a registry.
381+ Push to an OCI image container given GardenLinux canonical named artifacts
382+ in a specified directory.
380383
381384 :since: 0.7.0
382385 """
@@ -451,7 +454,7 @@ def push_manifest_tags(
451454 tag : List [str ],
452455) -> None :
453456 """
454- Push artifacts and the manifest from a directory to a registry .
457+ Push tags to an OCI image container for a given GardenLinux canonical named image .
455458
456459 :since: 0.10.0
457460 """
@@ -483,7 +486,7 @@ def push_manifest_tags(
483486)
484487def save_container (container : str , tag : str , oci_archive : str ) -> None :
485488 """
486- Push to an OCI registry .
489+ Saves a given OCI image container as an OCI archive .
487490
488491 :since: 1.0.0
489492 """
@@ -513,7 +516,7 @@ def save_container(container: str, tag: str, oci_archive: str) -> None:
513516)
514517def tag_container (container : str , tag : str , additional_tag : List [str ]) -> None :
515518 """
516- Push to an OCI registry .
519+ Adds additional tags to a given OCI image container .
517520
518521 :since: 1.0.0
519522 """
@@ -570,7 +573,7 @@ def update_index(
570573 additional_tag : List [str ],
571574) -> None :
572575 """
573- Push a list of files from the `manifest_folder` to an index.
576+ Pushes manifests stored in a directory to a given OCI image index.
574577
575578 :since: 0.7.0
576579 """
0 commit comments