94 lines
2.6 KiB
Markdown
94 lines
2.6 KiB
Markdown
# stack-orchestrator-setup
|
|
|
|
## Setup Ansible
|
|
|
|
To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine.
|
|
|
|
## Setup Stack Orchestrator
|
|
|
|
This playbook will install Docker and Stack Orchestrator (laconic-so) on the machine if they aren't already present.
|
|
|
|
Run the following commands in the [`stack-orchestrator-setup`](./) directory.
|
|
|
|
### On Local Host
|
|
|
|
To setup stack orchestrator and docker locally, execute the `setup-laconic-so.yml` Ansible playbook:
|
|
|
|
```bash
|
|
LANG=en_US.utf8 ansible-playbook setup-laconic-so.yml --user $USER -kK
|
|
```
|
|
|
|
### On Remote Host
|
|
|
|
To run the playbook on a remote host:
|
|
|
|
- Create a new `hosts.ini` file:
|
|
|
|
```bash
|
|
cp ../hosts.example.ini hosts.ini
|
|
```
|
|
|
|
- Edit the [`hosts.ini`](./hosts.ini) file to run the playbook on a remote machine:
|
|
|
|
```ini
|
|
[deployment_host]
|
|
<host_name> ansible_host=<target_ip> ansible_user=<ssh_user> ansible_ssh_common_args='-o ForwardAgent=yes'
|
|
```
|
|
|
|
- Replace `<host_name>` with the alias of your choice
|
|
- Replace `<target_ip>` with the IP address or hostname of the target machine
|
|
- Replace `<ssh_user>` with the SSH username (e.g., dev, ubuntu)
|
|
|
|
- Verify that you are able to connect to the host using the following command
|
|
|
|
```bash
|
|
ansible all -m ping -i hosts.ini -k
|
|
|
|
# Expected output:
|
|
|
|
# <host_name> | SUCCESS => {
|
|
# "ansible_facts": {
|
|
# "discovered_interpreter_python": "/usr/bin/python3.10"
|
|
# },
|
|
# "changed": false,
|
|
# "ping": "pong"
|
|
# }
|
|
```
|
|
|
|
- Execute the `setup-laconic-so.yml` Ansible playbook for setting up stack orchestrator and docker on a remote machine:
|
|
|
|
```bash
|
|
LANG=en_US.utf8 ansible-playbook setup-laconic-so.yml -i hosts.ini --extra-vars='{ "target_host": "deployment_host"}' --user $USER -kK
|
|
```
|
|
|
|
## Verify Installation
|
|
|
|
- After the installation is complete, ensure that `$HOME/bin` is added to your `PATH` to access `laconic-so` from anywhere in the terminal. You can do this by running the following command:
|
|
|
|
```bash
|
|
export PATH="$HOME/bin:$PATH"
|
|
```
|
|
|
|
- To make this change permanent, add the following line to your shell configuration file (`~/.bashrc` or `~/.zshrc`, depending on your shell):
|
|
|
|
```bash
|
|
# For bash users
|
|
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.bashrc
|
|
|
|
# For zsh users
|
|
echo 'export PATH="$HOME/bin:$PATH"' >> ~/.zshrc
|
|
```
|
|
|
|
- Once the PATH is set, verify the installation by running the following commands:
|
|
|
|
```bash
|
|
# Check version of docker
|
|
docker --version
|
|
|
|
# Check version of docker compose
|
|
docker compose version
|
|
|
|
# Check version of Stack Orchestrator
|
|
laconic-so version
|
|
```
|