Skip to content

Commit

Permalink
docs: update cloudlab.md to reflect recent changes elsewhere
Browse files Browse the repository at this point in the history
  • Loading branch information
whentojump committed Aug 3, 2023
1 parent cd14af3 commit 6b2c31b
Showing 1 changed file with 78 additions and 33 deletions.
111 changes: 78 additions & 33 deletions docs/cloudlab.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,23 @@
# CloudLab getting started guide

## Create CloudLab experiments
## 1 Prerequisites

First, submit an account request to CloudLab (https://www.cloudlab.us/). Things to note:

- Select "Join Existing Project" and type: `Sieve-Acto`
- If you're an internal member, select "Join Existing Project" and type: `Sieve-Acto`. Otherwise, you'll have to join other existing projects or create a new one, which is not detailed here.
- The username and key you provide will be used for SSH login

Wait for the admin to approve your account. Once you are able to login, familiarize yourself with the web-based dashboard, and [the concept of *profiles* and *experiments*](https://docs.cloudlab.us/basic-concepts.html).

Although you should be able to login onto any machine instantiated by your project collaborators (i.e. a Linux user will be automatically created for you on every machine with `authorized_keys` set up), our current practice is to let everyone run code **on their own experiments**.
Although you should be able to log in to any machine instantiated by your project collaborators (i.e. a Linux user will be automatically created for you on every machine with `authorized_keys` set up), for us (`Sieve-Acto`), the current practice is to let everyone run code **on their own experiments**.

Next you'll prepare the dependencies either manually ([section 2](#2-manually-set-up-the-dependencies)) or automatically ([section 3](#3-automatically-set-up-the-dependencies), recommended).

## 2 Manually set up the dependencies

<details><summary>Click to show details</summary>

### 2.1 Create CloudLab experiments

Launch an experiment via the web dashboard:

Expand All @@ -18,58 +26,95 @@ Launch an experiment via the web dashboard:
- "Select OS image": `UBUNTU 20.04`
- "Optional physical node type": `c6420`
- Leave other parameters as default. (Especially those regarding temporary filesystem -- we'll deal with it after provisioning using Ansible.)
3. "Next". Give your experiment a name. "Next". "Next".
3. "Next". Give your experiment a name. "Next". "Finish".

Wait for the provisioning to finish. The web dashboard will show you the server address, in the form of `clnodeXXX.clemson.cloudlab.us`.
Wait for the provisioning to finish. The web dashboard will show you the server address, in the form of `<node>.<cluster>.cloudlab.us`. E.g. `clnode123.clemson.cloudlab.us`.

## Configure CloudLab machines
### 2.2 Install the dependencies with Ansible

We are going to manage CloudLab machines with Ansible **from our local machine**. (Ideally this "local machine" can be a CloudLab one too. However, the scripts were not designed to do so and may mess things up. For the time being, minor tweaks are needed in order to let them function properly in such cases.)
We are going to manage CloudLab machines with Ansible from a controller node. This "controller" can be your local machine, or one of the CloudLab machines themselves.

**On your local machine**:
**On your controller node**:

```shell
#
# Install Ansible
#
Install Ansible:

```shell
sudo apt update
sudo apt install software-properties-common
sudo apt -y install software-properties-common
sudo add-apt-repository --yes --update ppa:ansible/ansible
sudo apt install ansible
sudo apt -y install ansible
ansible-galaxy collection install ansible.posix
ansible-galaxy collection install community.general
```

#
# Checkout the repository
#
Clone the Ansible scripts:

cd ~
git clone https://github.com/xlab-uiuc/acto.git
cd acto/
```shell
git clone https://github.com/xlab-uiuc/acto-cloudlab.git /tmp/acto-cloudlab
```

#
# Prepare the CloudLab machine(s) with Ansible
#
Set up `ansible_hosts` file (**remember to replace the placeholders with your real domain and user name**):

cd scripts/ansible/
# TODO: replace the placeholders with your real domain and user name you
# obtained or submitted in the previous section
```shell
domain="clnodeXXX.clemson.cloudlab.us"
user="alice"

cd /tmp/acto-cloudlab/scripts/ansible/
echo "$domain ansible_connection=ssh ansible_user=$user ansible_port=22" > ansible_hosts
```

> If the controller is a CloudLab machine too, this step can be automated:
>
> ```shell
> sudo apt -y install xmlstarlet
>
> component_name=$( geni-get portalmanifest | xmlstarlet sel -N x="http://www.geni.net/resources/rspec/3" -t -v "//x:node/@component_id" )
> cluster_domain=$( echo $component_name | cut -d '+' -f 2 )
> node_subdomain=$( echo $component_name | cut -d '+' -f 4 )
> domain="${node_subdomain}.${cluster_domain}"
> user=$( geni-get user_urn | rev | cut -d '+' -f -1 | rev )
>
> cd /tmp/acto-cloudlab/scripts/ansible/
> echo "$domain ansible_connection=ssh ansible_user=$user ansible_port=22" > ansible_hosts
> ```
>
> Or even simpler, use `127.0.0.1` directly:
>
> ```shell
> cd /tmp/acto-cloudlab/scripts/ansible/
> echo 127.0.0.1 > ansible_hosts
> ```
(Only if the controller is a CloudLab machine too) work around the key authentication:
```shell
ssh-keygen -b 2048 -t rsa -f ~/.ssh/id_rsa -q -N "" && cat ~/.ssh/id_rsa.pub >> ~/.ssh/authorized_keys
```
Finally, run the Ansible scripts to install dependencies:
```shell
ansible-playbook -i ansible_hosts configure.yaml
```
## Run Acto
</details>
(Only if the controller is a CloudLab machine too) log out before jumping to section 4 and logging in again.
Go to [section 4](#4-run-acto).
## 3 Automatically set up the dependencies
TODO
## 4 Run Acto
Log in to the CloudLab machine, and run:
Login onto **the CloudLab machine**, and run:
<!-- TODO this is now sosp-ae because of Ansible scripts in acto-cloudlab -->
```shell
cd ~/acto
pip install -r requirements.txt # FIXME: see #247
cd ~/workdir/acto
make
python3 -m acto.reproduce \
--reproduce-dir test/cassop-330/trial-demo \
--config data/cass-operator/config.json
python3 reproduce_bugs.py --bug-id rdoptwo-287
```

0 comments on commit 6b2c31b

Please sign in to comment.