sn_testnet_deploy/
bootstrap.rs

1// Copyright (c) 2023, MaidSafe.
2// All rights reserved.
3//
4// This SAFE Network Software is licensed under the BSD-3-Clause license.
5// Please see the LICENSE file for more details.
6
7use std::{path::PathBuf, time::Duration};
8
9use crate::{
10    ansible::provisioning::{PrivateNodeProvisionInventory, ProvisionOptions},
11    error::Result,
12    write_environment_details, BinaryOption, DeploymentType, EnvironmentDetails, EnvironmentType,
13    EvmDetails, EvmNetwork, InfraRunOptions, LogFormat, NodeType, TestnetDeployer,
14};
15use colored::Colorize;
16use log::error;
17
18#[derive(Clone)]
19pub struct BootstrapOptions {
20    pub binary_option: BinaryOption,
21    pub chunk_size: Option<u64>,
22    pub environment_type: EnvironmentType,
23    pub evm_data_payments_address: Option<String>,
24    pub evm_network: EvmNetwork,
25    pub evm_payment_token_address: Option<String>,
26    pub evm_rpc_url: Option<String>,
27    pub full_cone_private_node_count: u16,
28    pub full_cone_private_node_vm_count: Option<u16>,
29    pub full_cone_private_node_volume_size: Option<u16>,
30    pub interval: Duration,
31    pub log_format: Option<LogFormat>,
32    pub max_archived_log_files: u16,
33    pub max_log_files: u16,
34    pub name: String,
35    pub network_contacts_url: Option<String>,
36    pub network_id: u8,
37    pub node_count: u16,
38    pub node_env_variables: Option<Vec<(String, String)>>,
39    pub node_vm_count: Option<u16>,
40    pub node_vm_size: Option<String>,
41    pub node_volume_size: Option<u16>,
42    pub output_inventory_dir_path: PathBuf,
43    pub peer: Option<String>,
44    pub region: String,
45    pub rewards_address: String,
46    pub symmetric_private_node_count: u16,
47    pub symmetric_private_node_vm_count: Option<u16>,
48    pub symmetric_private_node_volume_size: Option<u16>,
49}
50
51impl TestnetDeployer {
52    pub async fn bootstrap(&self, options: &BootstrapOptions) -> Result<()> {
53        let build_custom_binaries = options.binary_option.should_provision_build_machine();
54
55        write_environment_details(
56            &self.s3_repository,
57            &options.name,
58            &EnvironmentDetails {
59                deployment_type: DeploymentType::Bootstrap,
60                environment_type: options.environment_type.clone(),
61                evm_details: EvmDetails {
62                    network: options.evm_network.clone(),
63                    data_payments_address: options.evm_data_payments_address.clone(),
64                    payment_token_address: options.evm_payment_token_address.clone(),
65                    rpc_url: options.evm_rpc_url.clone(),
66                },
67                funding_wallet_address: None,
68                network_id: Some(options.network_id),
69                region: options.region.clone(),
70                rewards_address: Some(options.rewards_address.clone()),
71            },
72        )
73        .await?;
74
75        self.create_or_update_infra(&InfraRunOptions {
76            client_image_id: None,
77            client_vm_count: Some(0),
78            client_vm_size: None,
79            enable_build_vm: build_custom_binaries,
80            evm_node_count: Some(0),
81            evm_node_vm_size: None,
82            evm_node_image_id: None,
83            full_cone_nat_gateway_vm_size: None, // We can take the value from tfvars for bootstrap deployments.
84            full_cone_private_node_vm_count: options.full_cone_private_node_vm_count,
85            full_cone_private_node_volume_size: options.full_cone_private_node_volume_size,
86            genesis_vm_count: Some(0),
87            genesis_node_volume_size: None,
88            name: options.name.clone(),
89            nat_gateway_image_id: None,
90            node_image_id: None,
91            node_vm_count: options.node_vm_count,
92            node_vm_size: options.node_vm_size.clone(),
93            node_volume_size: options.node_volume_size,
94            peer_cache_image_id: None,
95            peer_cache_node_vm_count: Some(0),
96            peer_cache_node_vm_size: None,
97            peer_cache_node_volume_size: None,
98            region: options.region.clone(),
99            symmetric_nat_gateway_vm_size: None, // We can take the value from tfvars for bootstrap deployments.
100            symmetric_private_node_vm_count: options.symmetric_private_node_vm_count,
101            symmetric_private_node_volume_size: options.symmetric_private_node_volume_size,
102            tfvars_filenames: Some(
103                options
104                    .environment_type
105                    .get_tfvars_filenames(&options.name, &options.region),
106            ),
107        })
108        .map_err(|err| {
109            println!("Failed to create infra {err:?}");
110            err
111        })?;
112
113        let mut provision_options = ProvisionOptions::from(options.clone());
114        if build_custom_binaries {
115            self.ansible_provisioner
116                .print_ansible_run_banner("Build Custom Binaries");
117            self.ansible_provisioner
118                .build_autonomi_binaries(&provision_options, None)
119                .map_err(|err| {
120                    println!("Failed to build safe network binaries {err:?}");
121                    err
122                })?;
123        }
124
125        let mut failed_to_provision = false;
126
127        self.ansible_provisioner
128            .print_ansible_run_banner("Provision Normal Nodes");
129        match self.ansible_provisioner.provision_nodes(
130            &provision_options,
131            options.peer.clone(),
132            options.network_contacts_url.clone(),
133            NodeType::Generic,
134        ) {
135            Ok(()) => {
136                println!("Provisioned normal nodes");
137            }
138            Err(e) => {
139                println!("Failed to provision normal nodes: {e:?}");
140                failed_to_provision = true;
141            }
142        }
143
144        let private_node_inventory = PrivateNodeProvisionInventory::new(
145            &self.ansible_provisioner,
146            options.full_cone_private_node_vm_count,
147            options.symmetric_private_node_vm_count,
148        )?;
149
150        if private_node_inventory.should_provision_full_cone_private_nodes() {
151            match self.ansible_provisioner.provision_full_cone(
152                &provision_options,
153                options.peer.clone(),
154                options.network_contacts_url.clone(),
155                private_node_inventory.clone(),
156                None,
157            ) {
158                Ok(()) => {
159                    println!("Provisioned Full Cone nodes and Gateway");
160                }
161                Err(err) => {
162                    error!("Failed to provision Full Cone nodes and Gateway: {err}");
163                    failed_to_provision = true;
164                }
165            }
166        }
167
168        if private_node_inventory.should_provision_symmetric_private_nodes() {
169            self.ansible_provisioner
170                .print_ansible_run_banner("Provision Symmetric NAT Gateway");
171            self.ansible_provisioner
172                .provision_symmetric_nat_gateway(&provision_options, &private_node_inventory)
173                .map_err(|err| {
174                    println!("Failed to provision Symmetric NAT gateway {err:?}");
175                    err
176                })?;
177
178            self.ansible_provisioner
179                .print_ansible_run_banner("Provision Symmetric Private Nodes");
180            match self.ansible_provisioner.provision_symmetric_private_nodes(
181                &mut provision_options,
182                options.peer.clone(),
183                options.network_contacts_url.clone(),
184                &private_node_inventory,
185            ) {
186                Ok(()) => {
187                    println!("Provisioned Symmetric private nodes");
188                }
189                Err(err) => {
190                    error!("Failed to provision Symmetric Private nodes: {err}");
191                    failed_to_provision = true;
192                }
193            }
194        }
195
196        if failed_to_provision {
197            println!("{}", "WARNING!".yellow());
198            println!("Some nodes failed to provision without error.");
199            println!("This usually means a small number of nodes failed to start on a few VMs.");
200            println!("However, most of the time the deployment will still be usable.");
201            println!("See the output from Ansible to determine which VMs had failures.");
202        }
203
204        Ok(())
205    }
206}
sn_testnet_deploy/bootstrap.rs

sn_testnet_deploy/
bootstrap.rs
