Skip to content

[sequence numbers] Add sequence number option to documentation. #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[sequence numbers] Add sequence number option to documentation. #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,35 +20,35 @@ The clc utility has three commands and two flags. All of the rest of the options

`cc`

Create a new cloud config file for usage with an IaaS with stock support for file includes
Create a new cloud config file for usage with an IaaS with stock support for file includes
and etcd based env variables.

`vagrant`

Creates a user-data file, Vagrantfile and config.rb for use on your local system
Creates a user-data file, Vagrantfile and config.rb for use on your local system
with options mirroring those of your cloud config.

`units`

Creates unit files for services defined in your configuration.

`new`

Does all of the above. Intended for spinning up a new cluster.

### flags

`-config`

Points to config file. (default "clc.yaml")

`-root`

Points to root directory for configs and output. (default "./")

### config file

Clc config (default is clc.yaml). This file is used to set the discovery url for the production cluster, file includes for the generated cloud-config and user-data files (optional), the location of the file that defines our units, and a directory holding custom templates for any or all of the generated files. If no override templates are supplied, the [stock templates](https://github.com/winkapp/libclc/tree/master/templates) from [libclc](https://github.com/winkapp/libclc) will be used.
Clc config (default is clc.yaml). This file is used to set the discovery url for the production cluster, file includes for the generated cloud-config and user-data files (optional), the location of the file that defines our units, and a directory holding custom templates for any or all of the generated files. If no override templates are supplied, the [stock templates](https://github.com/winkapp/libclc/tree/master/templates) from [libclc](https://github.com/winkapp/libclc) will be used.

```
discovery: { discovery url like https://discovery.etcd.io/3245sfgsdfgsdgsdfg34 }
Expand All @@ -62,11 +62,12 @@ files: {specification for files to be included in cloud-config and user-data, to
path: {path the the desired destination of the file on cluster machines}
owner: {desired owner of the file on cluster machines}
permissions: {desired permissions of the file on cluster machines}

unit_config:
units:
- name: {name of the service}
type: {multi|single - multi option names the file [email protected] to enable running multiple instances}
sequence_number: {optional sequence number used to create versioned unit file names}
restart: {always|no - always will restart the service after any exit}
image: {docker image to run}
command: {command to pass when starting container. leave blank to use default container command}
Expand Down