v1

PolkachuIntern · PolkachuIntern · commit c98f03523bd5 · 2022-10-06T17:15:56.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,2 @@
+inventory.yaml
+inventory_testnet.yaml
diff --git a/README.md b/README.md
@@ -1 +1,42 @@
-# aptos-operator
+# Aptos Node Operator Ansible Scripts
+
+## Design Philosophy
+
+1. Cover scenarios with multiple playbooks (initial setup, node upgrade, validator migration, etc)
+2. Support both testnet and mainnet
+3. Support both validator and validator fullnode
+4. Will support public fullnode at a later date
+
+## TL/DR
+
+Once all set, you run one playbook to do a task, such as:
+
+```bash
+ansible-playbook main.yml -e "target=validator_mainnet"
+```
+
+The target can be:
+
+- validator_mainnet
+- fullnode_mainnet
+- validator_testnet
+- fullnode_testnet
+
+## Set up your own inventory file
+
+First create your own inventory file by copying the sample one. Then you customize the file with your own.
+
+```bash
+cp inventory.sample.yaml inventory.yaml
+```
+
+## Playbooks
+
+| Playbook           | Description                                  |
+| ------------------ | -------------------------------------------- |
+| `main.yml`         | Set up a new node                            |
+| `main_upgrade.yml` | Upgrade the node version and restart service |
+
+## Limitation
+
+These playbooks do not touch any key files. We already do it manually. We think you should too.
diff --git a/ansible.cfg b/ansible.cfg
@@ -0,0 +1,2 @@
+[defaults]
+inventory=inventory.yaml
diff --git a/group_vars/all.yml b/group_vars/all.yml
@@ -0,0 +1,2 @@
+aptos_repo: https://github.com/aptos-labs/aptos-core
+prometheus_port: 9101
diff --git a/group_vars/fullnode.yml b/group_vars/fullnode.yml
@@ -0,0 +1 @@
+p2p_port: '6182'
diff --git a/group_vars/mainnet.yml b/group_vars/mainnet.yml
@@ -0,0 +1,3 @@
+aptos_version: 'a059b3d6965c63d124da09db83eed4f1221c6896'
+waypoint: https://raw.githubusercontent.com/aptos-labs/aptos-genesis-waypoint/main/premainnet/waypoint.txt
+genesis: https://github.com/aptos-labs/aptos-genesis-waypoint/blob/main/premainnet/genesis.blob?raw=true
diff --git a/group_vars/testnet.yml b/group_vars/testnet.yml
@@ -0,0 +1 @@
+aptos_version: 'a059b3d6965c63d124da09db83eed4f1221c6896'
diff --git a/group_vars/validator.yml b/group_vars/validator.yml
@@ -0,0 +1 @@
+p2p_port: '6180'
diff --git a/inventory.sample.yaml b/inventory.sample.yaml
@@ -0,0 +1,34 @@
+---
+all:
+  hosts:
+    validator_mainnet:
+      ansible_host: 10.0.0.1
+      node_type: validator
+      network: mainnet
+      fullnode_ip: 10.0.0.2
+    fullnode_mainnet:
+      ansible_host: 10.0.0.2
+      node_type: fullnode
+      network: mainnet
+      validator_ip: 10.0.0.1
+    validator_testnet:
+      ansible_host: 10.0.0.3
+      node_type: validator
+      network: testnet
+      fullnode_ip: 10.0.0.4
+    fullnode_testnet:
+      ansible_host: 10.0.0.4
+      node_type: fullnode
+      network: testnet
+      validator_ip: 10.0.0.3
+  vars:
+    ansible_user: ubuntu
+    ansible_port: 22
+    ansible_ssh_private_key_file: '~/.ssh/id_rsa'
+    user_dir: "/home/{{ ansible_user }}"
+    path: "/sbin:/usr/sbin:/bin:/usr/bin:/usr/local/bin:/usr/local/go/bin:{{ user_dir }}/.cargo/bin"
+    aptos_directory: "{{ user_dir }}/aptos"
+    config_directory: "{{ user_dir }}/{{ network }}"
+    network_varfile: "group_vars/{{ network }}.yml"
+    node_type_varfile: "group_vars/{{ node_type }}.yml"
+    monitor_ip: "10.0.0.100"
diff --git a/main.yml b/main.yml
@@ -0,0 +1,11 @@
+---
+- name: Install
+  hosts: '{{ target }}'
+  gather_facts: false
+  vars_files:
+    - "{{ network_varfile }}"
+    - "{{ node_type_varfile }}"
+  roles:
+    # - aptos_install
+    # - aptos_configure
+    - aptos_launch
diff --git a/main_upgrade.yml b/main_upgrade.yml
@@ -0,0 +1,6 @@
+---
+- name: Upgrade to team's latest cut
+  hosts: '{{ target }}'
+  gather_facts: false
+  roles:
+    - aptos_upgrade
diff --git a/roles/aptos_configure/tasks/main.yml b/roles/aptos_configure/tasks/main.yml
@@ -0,0 +1,86 @@
+---
+- name: Ensure that the folder exists
+  file:
+    path: '{{ config_directory }}'
+    state: directory
+
+- name: Pull waypoint.txt
+  get_url:
+    url: "{{ waypoint }}"
+    dest: "{{ config_directory }}/waypoint.txt"
+    mode: "0644"
+
+- name: Pull genesis.blob
+  get_url:
+    url: "{{ genesis }}"
+    dest: "{{config_directory }}/genesis.blob"
+    mode: "0644"
+
+- name: Ensure that the data folder does not exist
+  file:
+    path: '{{ config_directory }}/data'
+    state: absent
+
+- name: Copy appropriate config file
+  template:
+    src: "{{ node_type }}.yaml.j2"
+    dest: "{{ config_directory }}/config/{{ node_type }}.yaml"
+    owner: "{{ ansible_user }}"
+    group: "{{ ansible_user }}"
+    mode: "0600"
+
+- name: Open p2p port
+  become: true
+  ufw:
+    rule: allow
+    proto: tcp
+    port: "{{ p2p_port }}"
+
+- name: Open prometheus port to the monitor IP
+  become: true
+  ufw:
+    rule: allow
+    proto: tcp
+    from_ip: "{{ monitor_ip}}"
+    port: "{{ prometheus_port }}"
+
+- name: install nginx package
+  become: true
+  apt:
+    name: nginx
+    state: present
+    update_cache: yes
+
+- name: Copy nginx config file to reverse proxy
+  become: true
+  template:
+    src: 'nginx.conf.j2'
+    dest: '/etc/nginx/sites-enabled/aptos_{{ node_type }}.conf'
+    owner: 'root'
+    group: 'root'
+    mode: '0644'
+
+- name: restart nginx service
+  become: true
+  systemd:
+    name: nginx
+    state: restarted
+    daemon_reload: yes
+    enabled: yes
+  changed_when: false
+
+- name: open nginx port
+  become: true
+  ufw:
+    rule: allow
+    port: '80'
+    proto: tcp
+
+- name: open validator's port to fullnode
+  become: true
+  ufw:
+    rule: allow
+    port: '6181'
+    proto: tcp
+    from_ip: "{{ fullnode_ip }}"
+  when: node_type == "validator"
diff --git a/roles/aptos_configure/templates/fullnode.yaml.j2 b/roles/aptos_configure/templates/fullnode.yaml.j2
@@ -0,0 +1,30 @@
+base:
+  role: "full_node"
+  data_dir: "{{ config_directory }}/data"
+  waypoint:
+    from_file: "{{ config_directory }}/waypoint.txt"
+
+execution:
+  genesis_file_location: "{{ config_directory }}/genesis.blob"
+
+full_node_networks:
+- network_id:
+    private: "vfn"
+  listen_address: "/ip4/0.0.0.0/tcp/6181"
+  seeds:
+    00000000000000000000000000000000d58bc7bb154b38039bc9096ce04e1237:
+      addresses:
+      - "/ip4/{{ validator_ip }}/tcp/6181/noise-ik/f0274c2774519281a8332d0bb9d8101bd58bc7bb154b38039bc9096ce04e1237/handshake/0"
+      role: "Validator"
+
+- network_id: "public"
+  discovery_method: "onchain"
+  listen_address: "/ip4/0.0.0.0/tcp/6182"
+  max_inbound_connections: 100
+  identity:
+    type: "from_file"
+    path: "{{ config_directory }}/keys/validator-full-node-identity.yaml"
+
+api:
+  enabled: true
+  address: "0.0.0.0:8080"
diff --git a/roles/aptos_configure/templates/nginx.conf.j2 b/roles/aptos_configure/templates/nginx.conf.j2
@@ -0,0 +1,12 @@
+server {
+    listen 80;
+{% if network == 'mainnet' %}
+    server_name aptos-{{ node_type }}.polkachu.com;
+{% else %}
+    server_name aptos-testnet-{{ node_type }}.polkachu.com;
+{% endif %}
+    add_header Access-Control-Allow-Origin *;
+    location / {
+      proxy_pass http://127.0.0.1:8080;
+    }
+}
diff --git a/roles/aptos_configure/templates/validator.yaml.j2 b/roles/aptos_configure/templates/validator.yaml.j2
@@ -0,0 +1,42 @@
+base:
+  role: "validator"
+  data_dir: "{{ config_directory }}/data"
+  waypoint:
+    from_file: "{{ config_directory }}/waypoint.txt"
+
+consensus:
+  safety_rules:
+    service:
+      type: "local"
+    backend:
+      type: "on_disk_storage"
+      path: "{{ config_directory }}/data/secure-data.json"
+      namespace: ~
+    initial_safety_rules_config:
+      from_file:
+        waypoint:
+          from_file: "{{ config_directory }}/waypoint.txt"
+        identity_blob_path: "{{ config_directory }}/keys/validator-identity.yaml"
+
+execution:
+  genesis_file_location: "{{ config_directory }}/genesis.blob"
+
+validator_network:
+  discovery_method: "onchain"
+  mutual_authentication: true
+  identity:
+    type: "from_file"
+    path: "{{ config_directory }}/keys/validator-identity.yaml"
+
+full_node_networks:
+- network_id:
+    private: "vfn"
+  listen_address: "/ip4/0.0.0.0/tcp/6181"
+  identity:
+    type: "from_config"
+    key: "b0f405a3e75516763c43a2ae1d70423699f34cd68fa9f8c6bb2d67aa87d0af69"
+    peer_id: "00000000000000000000000000000000d58bc7bb154b38039bc9096ce04e1237"
+
+api:
+  enabled: true
+  address: "0.0.0.0:8080"
diff --git a/roles/aptos_install/tasks/main.yml b/roles/aptos_install/tasks/main.yml
@@ -0,0 +1,40 @@
+---
+- name: Clone node repo
+  git:
+    repo: '{{ aptos_repo }}'
+    dest: '{{ aptos_directory }}'
+    version: '{{ aptos_version }}'
+    update: true
+    force: true
+    recursive: false
+
+- name: Run/update Aptos prep script
+  command: "{{ item }}"
+  args:
+    chdir: "{{ aptos_directory }}"
+  with_items:
+    - "./scripts/dev_setup.sh -b"
+  environment:
+    PATH: "{{ path }}"
+
+- name: run cargo build command
+  command: "{{ item }}"
+  args:
+    chdir: "{{ aptos_directory }}"
+  with_items:
+    - "cargo build --release"
+  environment:
+    PATH: '{{ path }}'
+
+- name: Copy binaries
+  become: true
+  copy:
+    src: "{{ aptos_directory }}/target/release/{{ item }}"
+    dest: "/usr/local/bin"
+    owner: root
+    group: root
+    mode: 0755
+    remote_src: true
+  loop:
+    - aptos
+    - aptos-node
diff --git a/roles/aptos_launch/tasks/main.yml b/roles/aptos_launch/tasks/main.yml
@@ -0,0 +1,16 @@
+---
+- name: Copy service file
+  become: true
+  template:
+    src: "aptos.service.j2"
+    dest: "/etc/systemd/system/aptos.service"
+    owner: root
+    group: root
+    mode: "0644"
+
+- name: Enable aptos service
+  become: true
+  systemd:
+    name: "aptos"
+    daemon_reload: true
+    enabled: true
diff --git a/roles/aptos_launch/templates/aptos.service.j2 b/roles/aptos_launch/templates/aptos.service.j2
@@ -0,0 +1,14 @@
+[Unit]
+Description=Aptos {{ network }} {{ node_type }}
+After=network-online.target
+
+[Service]
+User=ubuntu
+WorkingDirectory={{ config_directory }}
+ExecStart=/usr/local/bin/aptos-node --config {{ config_directory }}/config/{{ node_type }}.yaml
+Restart=always
+RestartSec=3
+LimitNOFILE=65535
+
+[Install]
+WantedBy=multi-user.target
diff --git a/roles/aptos_upgrade/tasks/main.yml b/roles/aptos_upgrade/tasks/main.yml

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+inventory.yaml`
	`2`	`+inventory_testnet.yaml`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+[defaults]`
	`2`	`+inventory=inventory.yaml`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+aptos_repo: https://github.com/aptos-labs/aptos-core`
	`2`	`+prometheus_port: 9101`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+aptos_version: 'a059b3d6965c63d124da09db83eed4f1221c6896'`
	`2`	`+waypoint: https://raw.githubusercontent.com/aptos-labs/aptos-genesis-waypoint/main/premainnet/waypoint.txt`
	`3`	`+genesis: https://github.com/aptos-labs/aptos-genesis-waypoint/blob/main/premainnet/genesis.blob?raw=true`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+aptos_version: 'a059b3d6965c63d124da09db83eed4f1221c6896'`