mirror of
https://github.com/yavook/kiwi-scp.git
synced 2024-12-25 02:23:01 +00:00
Documentation
This commit is contained in:
parent
755af1a4bb
commit
c07e7c92c8
2 changed files with 96 additions and 4 deletions
98
README.md
98
README.md
|
@ -2,22 +2,114 @@
|
|||
|
||||
The simple tool for managing container servers
|
||||
|
||||
|
||||
## Quick start
|
||||
|
||||
- Learn to use `docker` with `docker-compose`
|
||||
- Install kiwi-config
|
||||
- Look at [the example instance](./example/)
|
||||
- Look at [the example instance](./example)
|
||||
- Look at the output of `kiwi --help`
|
||||
- Start building your own instances
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
A convenience installer is available as [install.sh](./install.sh) in this directory.
|
||||
You can `curl | sh` it using the following one-liner.
|
||||
|
||||
```shell script
|
||||
curl --proto '=https' --tlsv1.2 -sSf 'https://raw.githubusercontent.com/ldericher/kiwi-config/master/install.sh' | sh
|
||||
```
|
||||
|
||||
That script checks for the basic dependencies of the `kiwi` command, then downloads the main script and installs it to a location of your choice. Please consider installing `kiwi` into a directory inside your $PATH.
|
||||
The installer downloads the `kiwi` launcher script and installs it to a location of your choice.
|
||||
Please consider installing into a directory inside your `$PATH`.
|
||||
Run in a root shell or use `sudo sh` instead for system-wide installation.
|
||||
|
||||
You should now be able to run `kiwi init --show` and see the default configuration file.
|
||||
This downloads the latest version of the main kiwi-config executable and sets it up for you.
|
||||
|
||||
|
||||
### Adjusting environment for `kiwi`
|
||||
|
||||
`kiwi-config` depends on Python 3.6 (or later), [pipenv](https://pipenv.pypa.io/), and
|
||||
[less](http://www.greenwoodsoftware.com/less/) being in your `$PATH`.
|
||||
|
||||
In some cases, notably when using a multi-version system such as
|
||||
[CentOS SCL](https://wiki.centos.org/AdditionalResources/Repositories/SCL), not all of these are in your `$PATH`
|
||||
at login time.
|
||||
|
||||
In those cases, you can simply create a `.kiwienv` file in your home directory.
|
||||
It will be sourced every time you use the `kiwi` command.
|
||||
For the aforementioned case where you installed `centos-release-scl` and `rh-python36`, your `~/.kiwienv` should
|
||||
contain:
|
||||
|
||||
```shell script
|
||||
#!/bin/sh
|
||||
|
||||
. /opt/rh/rh-python36/enable
|
||||
```
|
||||
|
||||
|
||||
## Get started
|
||||
|
||||
TODO
|
||||
### Create a kiwi-config instance
|
||||
|
||||
Any directory is implicitly a valid `kiwi-config` instance using the default configuration.
|
||||
To prevent surprises however, you should run `kiwi init` in an empty directory and follow its directions before
|
||||
actually using `kiwi` more.
|
||||
|
||||
|
||||
### Concept
|
||||
|
||||
A `kiwi-config` instance is a directory containing a bunch of static configuration files.
|
||||
"Static" there as in "those don't change during normal service operation".
|
||||
These files could be anything from actual `.conf` files to entire html-web-roots.
|
||||
|
||||
Non-static, but persistent files are to be kept in a "service data directory", by default `/var/kiwi`.
|
||||
In your `docker-compose.yml` files, you can refer to that directory as **${TARGETROOT}**.
|
||||
|
||||
Start the current directory as a `kiwi-config` instance using `kiwi up`, or stop it using `kiwi down`.
|
||||
This also creates kiwi's internal hub network, which you can use as **kiwi_hub** in your `docker-compose.yml` files.
|
||||
|
||||
|
||||
### Projects
|
||||
|
||||
A `kiwi-config` instance usually contains several projects.
|
||||
A project is a collection of dependent or at least logically connected services, described by a `docker-compose.yml`.
|
||||
A well-known example would be webserver + php + database.
|
||||
|
||||
To create a project, use the `kiwi new <project-name>` command.
|
||||
By default, this creates a new disabled project.
|
||||
Before enabling or starting, consider editing the new project's `docker-compose.yml` file to your liking.
|
||||
Finally, enable it with `kiwi enable <project-name>`.
|
||||
You can also create, enable or (analogously) disable multiple projects in a single command.
|
||||
|
||||
Each project will have its own place in the service data directory, which you can refer to as **${TARGETDIR}**.
|
||||
|
||||
Finally, start a project using `kiwi up <project-name>`.
|
||||
|
||||
|
||||
### Advanced kiwi-config
|
||||
|
||||
`kiwi-config` extends the logical bounds of `docker-compose` to handling multiple projects.
|
||||
|
||||
|
||||
#### The `kiwi_hub`
|
||||
|
||||
With kiwi-config, you get the internal kiwi_hub network for free.
|
||||
It allows for network communication between services in different projects.
|
||||
Be aware, services only connected to the kiwi_hub can't use a port mapping!
|
||||
In most cases, you will want to use this:
|
||||
|
||||
```yaml
|
||||
networks:
|
||||
- default
|
||||
- kiwi_hub
|
||||
```
|
||||
|
||||
|
||||
#### The `CONFDIR`
|
||||
|
||||
Sometimes, it's convenient to re-use configuration files across projects.
|
||||
For this use case, create a directory named `conf` in a project.
|
||||
Those will all be combined into a directory available as **${CONFDIR}** in your `docker-compose.yml` files.
|
||||
|
|
|
@ -21,7 +21,7 @@ def are_you_sure(prompt, default="no"):
|
|||
suffix = "[yes|NO]"
|
||||
|
||||
answer = input(
|
||||
f"{_surround('MUST HAVE CAREFULING IN PROGRESS', '!')}\n"
|
||||
f"{_surround('MUST HAVE CAREFULING IN PROCESS', '!')}\n"
|
||||
f"\n"
|
||||
f"{_emphasize(prompt)}\n"
|
||||
f"\n"
|
||||
|
|
Loading…
Reference in a new issue