Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated the install guide. Added Delfin UI and Strato UI #310

Merged
merged 3 commits into from
Jul 15, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 54 additions & 12 deletions content/soda-gettingstarted/installation-using-ansible.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,14 +35,14 @@ sudo apt-get update && sudo apt-get install -y git
```bash
git clone https://github.com/sodafoundation/installer.git
cd installer/ansible
# Checkout the required version. For example, to checkout v1.8.0 follow
git checkout v1.8.0
# Checkout the required version. For example, to checkout v1.9.0 follow
git checkout v1.9.0
chmod +x install_dependencies.sh && source install_dependencies.sh
export PATH=$PATH:/home/$USER/.local/bin
```

{{% notice note %}}
Checkout the latest stable release. Current stable release: [Navarino (v1.8.0)](https://github.com/sodafoundation/soda/releases/tag/v1.8.0). If you want to get the master branch of all components, you can skip this step. (Master may not be stable or tested fully)
Checkout the latest stable release. Current stable release: [Okinawa (v1.9.0)](https://github.com/sodafoundation/soda/releases/tag/v1.9.0). If you want to get the master branch of all components, you can skip this step. (Master may not be stable or tested fully)
{{% /notice %}}


Expand Down Expand Up @@ -85,7 +85,8 @@ delfin (Dolphin in Spanish!), the SODA Infrastructure Manager project is an open
- Enable following configurations
- In file installer/ansible/group_vars/delfin.yml `enable_delfin: true`
- In file installer/ansible/group_vars/srm-toolchain.yml `install_srm_toolchain: true`
- In file installer/ansible/group_vars/dashboard.yml `enable_dashboard: true`
- In file installer/ansible/group_vars/dashboard.yml `enable_dashboard: true` **OR**
- In file installer/ansible/group_vars/delfin-ui.yml `enable_delfin_ui: true`
- **[Click here](#configure-delfin-installation) for other supported configuration details**

---
Expand All @@ -103,8 +104,9 @@ delfin (Dolphin in Spanish!), the SODA Infrastructure Manager project is an open
Strato installs SODA Multicloud only.
- Enable following configurations
- In file installer/ansible/group_vars/gelato.yml update the value `enable_gelato : true`.
- In file installer/ansible/group_vars/dashboard.yml `enable_dashboard: true`
- In file installer/ansible/group_vars/common.yml `host_ip : <User's IP address, eg. 127.0.0.1>`
- In file installer/ansible/group_vars/dashboard.yml `enable_dashboard: true` **OR**
- In file installer/ansible/group_vars/strato-ui.yml `enable_strato_ui: true`
- **[Click here](#enable-storage-service-plans-in-multicloud) for other supported configuration details**
---

Expand All @@ -131,21 +133,24 @@ sudo -E env "PATH=$PATH" ansible-playbook site.yml -i local.hosts -vvv --tags de
```
Supported tags: `keystone`, `hotpot`, `dock`, `delfin`, `srm_toolchain`, `gelato`, `sushi`, `dashboard`, `orchestration`

---


---

#### Enable dashboard installation (optional)
### Enable SODA Dashboard (optional)


Update the file `installer/ansible/group_vars/dashboard.yml` and change the value of `enable_dashboard` to `true`

Update the file `installer/ansible/group_vars/dashboard.yml` and change the value of `enable_dashboard` to `true`

```bash
# Install dashboard (true/false)
enable_dashboard: true

```
```

{{% notice info %}}
Starting with the Okinawa release of SODA two new user interfaces can be installed; Delfin UI and Strato UI. These allows users to install only those components required for the respective projects. The SODA Dashboard can be installed alongside these user interfaces. The features are currently the same.
Users who wish to test Terra features will have to use the SODA Dashboard. Users who wish to test Strato and Delfin features can use the SODA Dashboard or the respective independent UI.
{{% /notice %}}

---


Expand All @@ -159,6 +164,24 @@ enable_storage_service_plans: true
```
For more information on how to use SSP you can check out the [user guide](/guides/user-guides/multi-cloud/storage-service-plan)

---

### Enable Strato UI (optional)

Starting with the Okinawa release (v1.9.0) of SODA a separate user interface is available to experience the SODA Strato project.
This project is called the Strato UI and can be enabled by updating the file `installer/ansible/group_vars/strato-ui.yml` and change the value of `enable_strato_ui` to `true`
The Strato UI console is served on port 9003. This can be changed in the same config file.

```bash
enable_strato_ui: true

strato_ui_port: 9003
```

{{% notice info %}}
Strato UI requires a working Strato installation and the SODA Keystone authentication to be installed.
{{% /notice %}}

---
#### Multi-Cloud installation in High Availability (HA) Mode.
The default SODA installation of the multi-cloud project is on a single node (the same node is used for all projects).
Expand Down Expand Up @@ -360,6 +383,25 @@ grafana_port: 3000

{{% /notice %}}

---

### Enable Delfin UI (optional)

Starting with the Okinawa release (v1.9.0) of SODA a separate user interface is available to experience the SODA Delfin project.
This project is called the Delfin UI and can be enabled by updating the file `installer/ansible/group_vars/delfin-ui.yml` and change the value of `enable_delfin_ui` to `true`
The Delfin UI console is served on port 9001. This can be changed in the same config file.

```bash
enable_delfin_ui: true

delfin_ui_port: 9001
```

{{% notice info %}}
Delfin UI requires a working Delfin installation and the SRM toolchain to be installed.
{{% /notice %}}


---

### How to test SODA On Premise (Hotpot)
Expand Down