coop-cloud/abra
coop-cloud
/
abra
5
2
Fork 14
Code Issues Pull Requests 4 Packages Releases 36 Activity

docs: focus more on straight ssh docs for server add

This commit is contained in:
decentral1se 2022-02-03 13:42:49 +01:00
parent 4e09f3b9a8
commit 5237c7ed50
Signed by: decentral1se
GPG Key ID: 03789458B3D0C410
1 changed files with 15 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
cli/server/add.go
View File

@ -372,39 +372,27 @@ var serverAddCommand = cli.Command{
Usage: "Add a server to your configuration", Usage: "Add a server to your configuration",
Description: ` Description: `
This command adds a new server to your configuration so that it can be managed This command adds a new server to your configuration so that it can be managed
by Abra. This can be useful when you already have a server provisioned and want by Abra. This command can also provision your server ("--provision/-p") with a
to start running Abra commands against it. Docker installation so that it is capable of hosting Co-op Cloud apps.
This command can also provision your server ("--provision/-p") so that it is Abra will default to expecting that you have a running ssh-agent and are using
capable of hosting Co-op Cloud apps. Abra will default to expecting that you SSH keys to connect to your new server. Abra will also read your SSH config
have a running ssh-agent and are using SSH keys to connect to your new server. (matching "Host" as <domain>). SSH connection details precedence follows as
Abra will also read your SSH config (matching "Host" as <domain>). SSH such: command-line > SSH config > guessed defaults.
connection details precedence follows as such: command-line > SSH config >
guessed defaults.
If you have no SSH key configured for this host and are instead using password If you have no SSH key configured for this host and are instead using password
authentication, you may pass "--ssh-auth password" to have Abra ask you for the authentication, you may pass "--ssh-auth password" to have Abra ask you for the
password. "--ask-sudo-pass" may be passed if you run your provisioning commands password. "--ask-sudo-pass" may be passed if you run your provisioning commands
via sudo privilege escalation. via sudo privilege escalation.
If "--local" is passed, then Abra assumes that the current local server is The <domain> argument must be a publicy accessible domain name which points to
intended as the target server. This is useful when you want to have your entire your server. You should working SSH access to this server already, Abra will
Co-op Cloud config located on the server itself, and not on your local assume port 22 and will use your current system username to make an initial
developer machine. connection. You can use the <user> and <port> arguments to adjust this.
Example: Example:
abra server add --local abra server add varia.zone glodemodem 12345 -p
Otherwise, you may specify a remote server. The <domain> argument must be a
publicy accessible domain name which points to your server. You should have SSH
access to this server, Abra will assume port 22 and will use your current
system username to make an initial connection. You can use the <user> and
<port> arguments to adjust this.
Example:
abra server add --provision varia.zone glodemodem 12345
Abra will construct the following SSH connection and Docker context: Abra will construct the following SSH connection and Docker context:
@ -412,9 +400,11 @@ Abra will construct the following SSH connection and Docker context:
All communication between Abra and the server will use this SSH connection. All communication between Abra and the server will use this SSH connection.
In this example, Abra will install Docker and initialise swarm mode. If "--local" is passed, then Abra assumes that the current local server is
intended as the target server. This is useful when you want to have your entire
Co-op Cloud config located on the server itself, and not on your local
developer machine.
You may omit flags to avoid performing this provisioning logic.
`, `,
Flags: []cli.Flag{ Flags: []cli.Flag{
internal.DebugFlag, internal.DebugFlag,