diff --git a/docs/atomiccommandcheatsheet.rst b/docs/atomiccommandcheatsheet.rst index 8fa0bce..10b7350 100644 --- a/docs/atomiccommandcheatsheet.rst +++ b/docs/atomiccommandcheatsheet.rst @@ -6,25 +6,43 @@ This chapter contains cheat sheet for atomic commands **The atomic command ``/usr/bin/atomic`` defines the entrypoint of Project Atomic hosts** -- ``atomic host upgrade`` upgrades to a newer version. -- ``atomic host rollback`` rollbacks to the previous version. -- ``atomic host status`` shows the current status of the installed atomic host. +- ``atomic host`` host subcommands: + - ``atomic host deploy `` deploys a specific commit. + - ``atomic host install`` installs a layered rpm package. + - ``atomic host rebase `` downloads and deploys a new origin refspec. + - ``atomic host rollback`` rollbacks to the previous version. + - ``atomic host status`` shows the current status of the installed atomic host. + - ``atomic host uninstall`` removes a layered rpm package. + - ``atomic host unlock`` makes the current deployment mutable. + - ``atomic host upgrade`` upgrades to a newer version. +- ``atomic containers`` container subcommands: + - ``atomic containers delete `` deletes specified container. + - ``atomic containers list`` lists the installed containers. + - ``atomic containers trim`` discards unused blocks on running containers. + - ``atomic containers update `` updates a container. + - ``atomic containers rollback `` rolls back a container to a previous version (only for system containers). +- ``atomic diff`` shows difference between to container images, RPMs or file diff. +- ``atomic images`` image subcommands: + - ``atomic images delete `` marks an image for deletion. + - ``atomic images generate`` generates missing image manifests. + - ``atomic images info `` returns LABEL Information of the image. + - ``atomic images list`` displays all the container image present on the host. + - ``atomic images prune`` deletes dangling images. + - ``atomic images update `` pulls latest image from registry. + - ``atomic images verify `` verifies that the image is updated. + - ``atomic images version `` displays image 'Name Version Release' label. +- ``atomic install `` executes container image install method. +- ``atomic mount`` mounts container image to a specific directory. +- ``atomic pull`` pulls the latest image from the repository. +- ``atomic push (upload)`` pushes (upload) the latest image to the repository. - ``atomic run `` executes container image run method. -- ``atomic install `` installs a container on atomic host with systemd unit file to run it as service. +- ``atomic scan `` scans the image or container. +- ``atomic sign `` signs the specified image. +- ``atomic stop `` executes container image stop method. +- ``atomic storage (migrate)`` manages container storage. +- ``atomic top`` shows stats about processes running inside container. +- ``atomic trust`` manages container trust policy. - ``atomic uninstall `` uninstalls the container from the atomic host. -- ``atomic info `` returns LABEL Information of the image. -- ``atomic images`` displays all the container image present on the atomic host. -- ``atomic scan `` scans the image or container -- ``atomic stop `` executes container image stop method -- ``atomic mount`` mounts container image to a specific directory -- ``atomic diff`` shows difference between to container images, RPMs or file diff -- ``atomic push`` pushes (upload) the latest image to the repository -- ``atomic pull`` pulls the latest image from the repository -- ``atomic top`` shows stats about processes running inside container -- ``atomic storage`` manages container storage -- ``atomic unmount`` unmount container image -- ``atomic update`` updates to the latest container image of the repository -- ``atomic version`` displays "Name Version Release" Label of the image -- ``atomic verify`` verifies that the image is fully updated +- ``atomic unmount`` unmounts container image. We have blog post for few commands. Check `this `_.