Skip to content
Snippets Groups Projects
Commit 9065de1b authored by Steve Milner's avatar Steve Milner Committed by Atomic Bot
Browse files

doc: Add USAGE.md and blog links


USAGE.md houses basic usage information for using system containers.

Signed-off-by: default avatarSteve Milner <smilner@redhat.com>

Closes: #122
Approved by: giuseppe
parent 2c773859
Branches
Tags
No related merge requests found
...@@ -34,4 +34,7 @@ ostree utility installed. ...@@ -34,4 +34,7 @@ ostree utility installed.
For more information on system containers see: For more information on system containers see:
http://www.projectatomic.io/blog/2016/09/intro-to-system-containers - [Basic usage](USAGE.md)
- http://www.projectatomic.io/blog/2016/09/intro-to-system-containers
- http://www.projectatomic.io/blog/2017/06/creating-system-containers/
- http://www.projectatomic.io/blog/2017/09/running-kubernetes-on-fedora-atomic-26/
USAGE.md 0 → 100644
# Installing System Containers
Installing system containers requires the ``atomic`` command.
## First: Pull the image
Pull from registry into ostree:
```
# atomic pull --storage ostree $REGISTRY/$IMAGE:$TAG
```
Or alternatively, pull from local docker:
```
# atomic pull --storage ostree docker:$IMAGE:$TAG
```
## Install the container
**Note**: Currently we recommend using --system-package=no to avoid having rpmbuild
create an rpm file during installation. This flag will tell the atomic CLI to fall
back to copying files to the host instead.
### Install without parameters
```
# atomic install --system --system-package=no --name=$NAME_FOR_SYSTEMD $REGISTRY/$IMAGE:$TAG
```
### Install with parameters
Some system containers can take in parameters. These parameters should be listed in
the system containers own README.md file. If for some reason a README.md does not
exist, one can check the ``defaultValues`` in the ``manifest.json`` file for
parameters to override.
```
# atomic install --system --system-package=no --name=$NAME_FOR_SYSTEMD \
--set=KEY=VAL --set=FOO=BAR $REGISTRY/$IMAGE:$TAG
```
## Running System Containers
### Start as a systemd service
```
# systemctl start $NAME_FOR_SYSTEMD
```
### Stopping the service
```
# systemctl stop $NAME_FOR_SYSTEMD
```
## Uninstalling System Containers
```
# atomic uninstall $NAME_FOR_SYSTEMD
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment