toolshed/docs.coopcloud.tech
toolshed/docs.coopcloud.tech
3
1
Fork 20
Code Issues 3 Pull Requests 1 Packages Releases Activity

Clarify a couple of things in deployment guide. #14

Merged
3wordchant merged 1 commits from knoflook/docs.coopcloud.tech:main into main 2021-06-24 21:24:35 +00:00
Conversation 2 Commits 1 Files Changed 1 +30 -3
1 changed files with 30 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/deploy.md
View File

@ -22,7 +22,7 @@ Where `116.203.211.204` can be replaced with the IP address of your server.
## Install server prerequisites
On your server, you'll want to install [Docker](https://www.docker.com/). This can be done by following the [install documentation](https://docs.docker.com/engine/install/).
You'll want to install [Docker](https://www.docker.com/) both on your server and your local machine. This can be done by following the [install documentation](https://docs.docker.com/engine/install/).
On a [Debian system](https://docs.docker.com/engine/install/debian/), that can be done like so.
@ -86,6 +86,23 @@ Once you've added the sever, you can initialise the [new single-host swarm](http
abra server example.com init
```
You might see some messages from docker-swarm such as:
decentral1se marked this conversation as resolved
decentral1se commented 2021-06-23 11:31:46 +00:00
Review
Copy Link

We have discussed making the underlying tools visible so as to make more clear that abra is a thin wrapper on other tools. Also see 57f3f96bbc/abra (L1322) as an example of that. However, this does show how this approach can be confusing for newcomers! I have pondered if we should be capturing this output instead? We still explain what is going on but make it more clear through output we control? I will open a ticket for this.

These docs are good as is though 🚀

We have discussed making the underlying tools visible so as to make more clear that `abra` is a thin wrapper on other tools. Also see https://git.autonomic.zone/coop-cloud/abra/src/commit/57f3f96bbc05836633b833b4eb5d03d219bd2820/abra#L1322 as an example of that. However, this does show how this approach can be confusing for newcomers! I have pondered if we should be capturing this output instead? We still explain what is going on but make it more clear through output we control? I will open a ticket for this. These docs are good as is though 🚀
```bash
Swarm initialized: current node (<node id>) is now a
manager.
To add a worker to this swarm, run the following command:
docker swarm join --token <token> <IP address>
To add a manager to this swarm, run 'docker swarm join-token manager'
and follow the instructions.
<node id>
```
You will now have a new `~/.abra/` folder on your local file system which stores all the configuration of your Co-op Cloud instance. You can easily share this as a git repository with others.
## Deploy Traefik
@ -110,7 +127,11 @@ This is the required environment variables that you can configure and are inject
abra app traefik deploy
```
We can then check that everything came up as expected.
If you get a message like this:
```bash
ERROR: https://traefik.example.com still isn't up, check status by running "abra app traefik ps"
```
It might need a few seconds more to start up. We can then check that everything came up as expected.
decentral1se marked this conversation as resolved
decentral1se commented 2021-06-23 11:31:42 +00:00
Review
Copy Link

FYI we're working on making this domain not mandatory if you don't enable the Traefik dashboard in https://git.autonomic.zone/coop-cloud/traefik/issues/24. Most people won't need it. When there is no domain, abra skips over this message. This note is also great to have though.

FYI we're working on making this domain not mandatory if you don't enable the Traefik dashboard in https://git.autonomic.zone/coop-cloud/traefik/issues/24. Most people won't need it. When there is no domain, `abra` skips over this message. This note is also great to have though.
```bash
abra app traefik ps # status check
@ -129,12 +150,18 @@ abra app new --server example.com --domain cloud.example.com nextcloud
We can then choose `nextcloud` as the app name.
And we need to generate secrets for the app: database connection password, root password and admin password.
And we need to generate secrets for the app: database connection password, root password and admin password.
```bash
abra app nextcloud secret generate --all
```
If abra complains about lacking pwqgen, it is available in the packet passwdqc on debian. Install it with
decentral1se marked this conversation as resolved
decentral1se commented 2021-06-23 11:32:34 +00:00
Review
Copy Link

Nice! Yeah we're working on removing this requirement in https://git.autonomic.zone/coop-cloud/abra/issues/167. Good to have this.

Nice! Yeah we're working on removing this requirement in https://git.autonomic.zone/coop-cloud/abra/issues/167. Good to have this.
```bash
sudo apt-get install passwdqc
```
and run the previous command again.
!!! warning
Take care, these secrets are only shown once on the terminal so make sure