Skip to content
This repository was archived by the owner on Feb 26, 2024. It is now read-only.

Commit e794096

Browse files
committed
docs: update documentation
1 parent 593e3cd commit e794096

File tree

11 files changed

+55
-149
lines changed

11 files changed

+55
-149
lines changed

Documentation/SUMMARY.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,30 +7,20 @@
77
* [Workflow](introduction/workflow.md)
88
* [Project definition](introduction/project-definition.md)
99
* [Getting started](introduction/getting-started.md)
10+
* [CLI configuration](introduction/cli-configuration.md)
11+
* [Commands](introduction/commands.md)
1012

1113
## Development
1214

1315
* [Basics](development/basics.md)
1416
* [Events](development/events.md)
1517

16-
## StackHead CLI
17-
18-
* [Installation](stackhead-cli/installation.md)
19-
* [Commands](stackhead-cli/commands.md)
20-
* [Configuration](stackhead-cli/cli-configuration.md)
21-
2218
## StackHead modules
2319

2420
* [About modules](stackhead-modules/stackhead-modules.md)
2521
* [List of modules](stackhead-modules/list-of-modules.md)
2622
* [Development](stackhead-modules/development/README.md)
2723

28-
## Ansible Collection <a id="ansible-playbooks"></a>
29-
30-
* [Installation](ansible-playbooks/installation.md)
31-
* [Inventory](ansible-playbooks/inventory.md)
32-
* [Playbooks](ansible-playbooks/playbooks.md)
33-
3424
## Technical Documentation
3525

3626
* [Terraform](technical-documentation/terraform.md)

Documentation/ansible-playbooks/installation.md

Lines changed: 0 additions & 16 deletions
This file was deleted.

Documentation/ansible-playbooks/inventory.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

Documentation/ansible-playbooks/playbooks.md

Lines changed: 0 additions & 20 deletions
This file was deleted.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Configuration
2+
3+
StackHead will look for a file named `.stackhead-cli.yml` in the working directory or in the home directory of the user executing the command.
4+
5+
This file is used to configure which StackHead modules to use.
6+
7+
You may define additional module configurations within the `modules_config` key.
8+
See example below for setting the setting _server_names_hash_bucket_size_ for the Nginx proxy module.
9+
10+
## Full annotated configuration
11+
12+
```yaml
13+
---
14+
modules:
15+
proxy: nginx
16+
container: docker
17+
plugins:
18+
- portainer
19+
dns:
20+
- cloudflare
21+
modules_config:
22+
nginx: # config settings for Nginx module
23+
certificates_email: "my-certificates-mail@mydomain.com" # Email address used for creating SSL certificates. Will receive notice when they expire.
24+
config:
25+
server_names_hash_bucket_size: 128
26+
terraform:
27+
update_interval: "*-*-* 4:00:00" # perform Terraform update everyday at 4am, see Unix timer "OnCalendar" setting
28+
```
29+
30+
{% hint style="info" %}
31+
Please look at the individual README files of the modules for all available configuration settings.
32+
{% endhint %}
33+
Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,4 @@ The following commands are available in StackHead CLI:
1414
| `project destroy [path to project definition] [ip address]` | Remove a deployed project |
1515
| `project validate [path to project definition]` | Validate a project definition file |
1616
| `cli validate [path to cli configuration]` | Validate a StackHead CLI configuration file |
17-
| `module validate [path to module file]` | Validate a StackHead module file |
1817

Documentation/introduction/getting-started.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,12 @@ description: >-
88

99
You will require:
1010

11-
* StackHead CLI \(see [Installation Guide](../stackhead-cli/installation.md)\)
11+
* StackHead CLI binary \(see [GitHub releases page](https://github.com/getstackhead/stackhead/releases)\)
1212
* a top level domain
1313
* a web server with SSH root access
1414

15+
If you wish to change the software used for proxy or containers, please [create a CLI configuration file](cli-configuration.md).
16+
1517
## Creating a project definition
1618

1719
Create a new project definitions file at `./stackhead/example_app.yml` and the following content:

Documentation/introduction/workflow.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# Workflow
22

3-
StackHead utilizes Ansible and Terraform to set up your projects.
3+
StackHead utilizes Terraform to set up your projects.
44

5+
Outdated process image:
56
![StackHead process](../.gitbook/assets/stackhead-process.png)
67

7-
The figure above illustrates the general StackHead workflow. StackHead provides custom Ansible playbooks for installing required software on a remote server \(setup\) and configuring your projects \(deployment\).
8+
The figure above illustrates the general StackHead workflow.
9+
StackHead provides tooling for installing required software on a remote server \(setup\) and configuring your projects \(deployment\).
810

911
The highlighted terms are explained in further detail below.
1012

@@ -18,16 +20,17 @@ Based on the project definition file, StackHead will take care setting up the re
1820

1921
## Server setup
2022

21-
During server setup all software and utilities that are required to set up your projects with StackHead are installed. Such may include Terraform, container management software \(e.g. Docker\) and web server software \(e.g. Nginx\). You'll have to run the server setup before you can deploy projects onto it.
22-
23-
The server setup is executed by running the respective Ansible playbook.
23+
During server setup all software and utilities that are required to set up your projects with StackHead are installed.
24+
Such may include Terraform, container management software \(e.g. Docker\) and web server software \(e.g. Nginx\). You'll have to run the server setup before you can deploy projects onto it.
2425

2526
## Project deployment
2627

27-
Setting up a project is called deployment and is done by running the respective Ansible playbook. This will create all project-related resources such as web server configuration, SSL certificates and start up containers.
28+
Setting up a project is called deployment.
29+
A deployment will create all project-related resources such as reverse proxy configuration, SSL certificates and it will start up containers.
2830

2931
{% hint style="info" %}
3032
Only servers that have been set up using the StackHead **server setup** can be deployed onto!
33+
In the future it will be possible to deploy onto servers not provisioned by StackHead (see https://github.com/getstackhead/stackhead/issues/169).
3134
{% endhint %}
3235

3336
## Resource management

Documentation/stackhead-cli/cli-configuration.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

Documentation/stackhead-cli/installation.md

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)