Skip to content
This repository was archived by the owner on Jul 5, 2021. It is now read-only.

Update atomic commands #24

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 36 additions & 18 deletions docs/atomiccommandcheatsheet.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <revision>`` deploys a specific commit.
- ``atomic host install`` installs a layered rpm package.
- ``atomic host rebase <refspec>`` 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 <name>`` deletes specified container.
- ``atomic containers list`` lists the installed containers.
- ``atomic containers trim`` discards unused blocks on running containers.
- ``atomic containers update <name>`` updates a container.
- ``atomic containers rollback <name>`` 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 <name>`` marks an image for deletion.
- ``atomic images generate`` generates missing image manifests.
- ``atomic images info <name>`` 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 <name>`` pulls latest image from registry.
- ``atomic images verify <name>`` verifies that the image is updated.
- ``atomic images version <name>`` displays image 'Name Version Release' label.
- ``atomic install <name>`` 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 <name>`` executes container image run method.
- ``atomic install <name>`` installs a container on atomic host with systemd unit file to run it as service.
- ``atomic scan <name>`` scans the image or container.
- ``atomic sign <name>`` signs the specified image.
- ``atomic stop <name>`` 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 <name>`` uninstalls the container from the atomic host.
- ``atomic info <name>`` returns LABEL Information of the image.
- ``atomic images`` displays all the container image present on the atomic host.
- ``atomic scan <name>`` scans the image or container
- ``atomic stop <name>`` 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 <https://trishnag.wordpress.com/2016/08/11/getting-started-with-atomic-commands/>`_.