Skip to content

Commit

Permalink
#12 : Add doc to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nicolas43000 committed Nov 20, 2020
1 parent 4bc7a60 commit f1db046
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,13 +112,33 @@ If you need to build the images you need in a stack, you can execute the followi
`kloud image:build`

To enable experimental images, you will need to add option `--with-experimental`.

### Test the required images

If you need to test if the images you are using are following every constraint you would expect:

`kloud image:test`

### Environment commands

After `kloud stack:init`, you can use several environment commands to do several things on a remote server

* `kloud environment:init`: Initialize the environment file in local workspace.
* `kloud environment:variable:add`: Add an environment variable.
* `kloud environment:variable:unset`: Unset an environment variable value.
* `kloud environment:variable:get`: Print an environment variable value.
* `kloud environment:variable:set`: Change an environment variable value.
* `kloud environment:variable:list`: Print the list of environment variables and their value.
* `kloud environment:deploy`: Deploy the application to a remote server using rsync and initialize docker services.
* `kloud environment:destroy`: Destroy the docker infrastructure with associated volumes and remove remote directory.
* `kloud environment:start`: Start docker services on the remote server.
* `kloud environment:stop`: Stop docker services on the remote server.
* `kloud environment:rsync`: Synchronize remote directory according to local directory.
* `kloud environment:cache:clear`: SClear cache and restart FPM service.
* `kloud environment:database:dump`: Dump the database in the current state.
* `kloud environment:database:load`: Load a database dump.
* `kloud environment:shell`: Start a shell session for a service.

Frequently Asked Questions
---

Expand Down

0 comments on commit f1db046

Please sign in to comment.