testnet-ops/service-provider-setup/README.md

142 lines
3.7 KiB
Markdown
Raw Normal View History

2024-09-18 07:48:48 +00:00
# service-provider-setup
2024-09-18 10:08:38 +00:00
## Setup Ansible
To get started, follow the [installation](../README.md#installation) guide to setup ansible on your machine
2024-09-23 13:29:16 +00:00
## Setup User `dev`
- 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 desired `hostname` of the remote machine
- Replace `<target_ip>` with the IP address or hostname of the target machine
- Replace `<ssh_user>` with `root`
- Verify that you are able to connect to the host using the following command:
```bash
ansible all -m ping -i hosts.ini
# Expected output:
# <host_name> | SUCCESS => {
# "ansible_facts": {
# "discovered_interpreter_python": "/usr/bin/python3.10"
# },
# "changed": false,
# "ping": "pong"
# }
```
- Setup `user-vars.yml` using the example file
```bash
cd vars
cp user-vars.example.yml user-vars.yml
```
- Edit the following vars:
```bash
# name of the user you want to setup on the target host
username: ""
# password of the user you want to setup on the target host
password: ""
# path to the ssh key on your machine
path_to_ssh_key: "
```
- Execute the `setup-user.yml` Ansible playbook to create a user with passwordless sudo permissions:
2024-09-23 13:29:16 +00:00
```bash
ansible-playbook setup-user.yml -i hosts.ini --extra-vars='{ "target_host": "deployment_host" }'
```
## Become a Service Provider
### Prerequisites
- Buy a domain and configure nameservers to DigitalOcean
- Generate a DigitalOcean access token
2024-09-23 13:29:16 +00:00
- Create a PGP key on your target host
2024-09-20 04:34:16 +00:00
2024-09-23 13:29:16 +00:00
```
gpg --full-generate-key
```
2024-09-20 04:34:16 +00:00
2024-09-23 13:29:16 +00:00
- List the secret keys
2024-09-20 04:34:16 +00:00
2024-09-23 13:29:16 +00:00
```
gpg --list-secret-keys --keyid-format=long
2024-09-20 04:34:16 +00:00
```
2024-09-23 13:29:16 +00:00
- This will output something like this
2024-09-20 04:34:16 +00:00
2024-09-23 13:29:16 +00:00
```
[keyboxd]
---------
sec rsa4096/0AFB10B643944C22 2024-05-03 [SC] [expires: 2025-05-03]
17B3248D6784EC6CB43365A60AFB10B643944C22
uid [ultimate] user <hello@laconic.com>
```
Note the `0AFB10B643944C22` sequence of characters. This will be required later.
2024-09-23 13:29:16 +00:00
- Copy the vars files:
2024-09-20 04:34:16 +00:00
```bash
2024-09-23 13:29:16 +00:00
cd vars
cp dns-vars.example.yml dns1-vars.yml
cp k8s-vars.example.yml k8s1-vars.yml
cp container-vars.example.yml container1-vars.yml
cp webapp-vars.example.yml webapp-vars.yml
2024-09-23 13:29:16 +00:00
```
2024-09-20 04:34:16 +00:00
- Update the following values in the respective variable files:
2024-09-20 04:34:16 +00:00
2024-09-23 13:29:16 +00:00
```bash
# vars/dns-vars.yml
domain: "" # eg: laconic.com
subdomain_prefix: "" # eg: lcn-cad
cluster_control_ip: "" # eg: 23.111.78.179
do_api_token: "" # eg: dop_v1...
2024-09-23 13:29:16 +00:00
# vars/k8s-vars.yml
target_host: "deployment_host"
gpg_key_id: "" # The sequence obtained in the previous step, eg: 0AFB10B643944C22
vault_passphrase: "" # passphrase for GPG key
org_id: "" # eg: lcn
location_id: "" # eg: cad
dns_domain: "" # eg: laconic.com
2024-09-23 13:29:16 +00:00
# vars/container-vars.yml
container_registry_username: "" # username to login to the container registry
container_registry_password: "" # password to login to the container registry
2024-09-23 13:29:16 +00:00
# vars/webapp-vars.yml
authority_name: "" # eg: my-org-name
2024-09-20 04:34:16 +00:00
```
2024-09-23 13:29:16 +00:00
- Update `ansible_user` in the [`hosts.ini`](./hosts.ini) file to the user on target host
2024-09-23 13:29:16 +00:00
- Run the `service-provider-setup.yml` ansible-playbook to DNS records, deploy k8s, setup container registry, deploy the webapp-deployer API and webapp-deployer UI
2024-09-23 13:29:16 +00:00
```bash
ansible-playbook service-provider-setup.yml -i hosts.ini --extra-vars='{ target_host: "deployment_host" }' --user $USER
2024-09-23 13:29:16 +00:00
```