From f9bdcfef2c7a2da71227f31ab02957eb3bc1150e Mon Sep 17 00:00:00 2001 From: rajat verma Date: Tue, 15 Sep 2020 14:12:17 +0530 Subject: [PATCH 01/11] add multi-cloud user guide --- .../developer-guides/file-share/_index.md | 5 +- .../object-lifecycle-management/_index.md | 8 +- .../guides/user-guides/file-share/_index.md | 26 ++-- .../guides/user-guides/multi-cloud/_index.md | 111 ++++++++++++++++++ .../object-lifecycle-management/_index.md | 26 ++-- .../user-guides/orchestration/_index.md | 44 +++---- .../guides/user-guides/telemetry/_index.md | 2 +- 7 files changed, 166 insertions(+), 56 deletions(-) create mode 100644 content/guides/user-guides/multi-cloud/_index.md diff --git a/content/guides/developer-guides/file-share/_index.md b/content/guides/developer-guides/file-share/_index.md index c3e3adf2..2fab697f 100644 --- a/content/guides/developer-guides/file-share/_index.md +++ b/content/guides/developer-guides/file-share/_index.md @@ -6,7 +6,7 @@ disableToc: false tags: ["developer guide", "file share"] --- -This tutorial guides users and new contributors to get familiar with OpenSDS by installing a simple local cluster and enabling NFS to use file share feature. You can also use the ansible script to install automatically. See details in OpenSDS Local Cluster Installation through ansible. +This tutorial guides users and new contributors to get familiar with SODA by installing a simple local cluster and enabling NFS to use file share feature. You can also use the ansible script to install automatically. See details in SODA Local Cluster Installation through ansible. ### Prerequisite Make sure you have all the following: @@ -18,8 +18,7 @@ Make sure you have all the following: ### Step by Step Installation There are two projects provided to user, if user only wants file share feature, they need to have github.com/sodafoundation/api, github.com/sodafoundation/controller, github.com/sodafoundation/dock and github.com/sodafoundation/dashboard (if you need GUI). -#### OpenSDS (Hotpot) FIXME-SODA -Bootstrap +#### SODA Bootstrap First you need to download bootstrap script and run it locally with root access. ``` curl -sSL https://raw.githubusercontent.com/opensds/opensds/master/install/devsds/bootstrap.sh | sudo bash diff --git a/content/guides/developer-guides/object-lifecycle-management/_index.md b/content/guides/developer-guides/object-lifecycle-management/_index.md index d29c3870..9bcafa4d 100644 --- a/content/guides/developer-guides/object-lifecycle-management/_index.md +++ b/content/guides/developer-guides/object-lifecycle-management/_index.md @@ -7,18 +7,18 @@ tags: ["developer guide", "object lifecycle"] --- ## Overview -This guide is intended for Object Lifecycle feature developers. It provides detailed steps to write new API using OpenSDS. To understand the feature and requirements in detail, please refer to the Object Lifecycle Management [user guide](/guides/user-guides/object-lifecycle-management/) and Object Lifecycle [design spec](https://github.com/opensds/design-specs/blob/master/specs/capri/object_lifecycle_management.md). +This guide is intended for Object Lifecycle feature developers. It provides detailed steps to write new API using SODA. To understand the feature and requirements in detail, please refer to the Object Lifecycle Management [user guide](/guides/user-guides/object-lifecycle-management/) and Object Lifecycle [design spec](https://github.com/opensds/design-specs/blob/master/specs/capri/object_lifecycle_management.md). ## APIs -APIs are a set of functions and procedures that allow for the creation of applications that access data and features of other applications, services or operating system. In OpenSDS lifecycle management feature we are using APIs to communicate with different storage backend. +APIs are a set of functions and procedures that allow for the creation of applications that access data and features of other applications, services or operating system. In SODA lifecycle management feature we are using APIs to communicate with different storage backend. ### Write new API Before starting to write the APIs, it is required to have basic understanding of XML and JSON syntax. #### There are three major steps involved: - a) All APIs go into the 's3' module of the OpenSDS multi-cloud package, i,e. opensds/multi-cloud/api/pkg/s3 directory + a) All APIs go into the 's3' module of the SODA multi-cloud package, i,e. opensds/multi-cloud/api/pkg/s3 directory ======= ## Write new API Before starting to write the APIs, it is required to have basic understanding of XML and JSON syntax. @@ -26,7 +26,7 @@ Before starting to write the APIs, it is required to have basic understanding of ## How to write the APIs ### There are three major steps involved: - a) All APIs goes into the 's3' module of the OpenSDS multi-cloud package, i,e. opensds/multi-cloud/api/pkg/s3 directory + a) All APIs goes into the 's3' module of the SODA multi-cloud package, i,e. opensds/multi-cloud/api/pkg/s3 directory b) The corresponding router for the API are defined same directory. c) For every API there must be a function defined in proto file. Example of adding API router (router.go): diff --git a/content/guides/user-guides/file-share/_index.md b/content/guides/user-guides/file-share/_index.md index 07963fcb..fc691222 100644 --- a/content/guides/user-guides/file-share/_index.md +++ b/content/guides/user-guides/file-share/_index.md @@ -1,20 +1,20 @@ --- -title: File Share feature User Guide +title: File Share description: "User guide for File Share feature." weight: 10 disableToc: false tags: ["user guide", "file share"] --- ## File Share Introduction -File share in opensds facilitates the user to create file share, set access permission for that file share and user can also create snapshot. Opensds provides both CLI and Dashboard to operate or play with file share feature. -Goals of file share in opensds are -Facilitating File Share Service by providing Standard API to manage multiple vendors, simplify File Share API definition -File share across the users based on access capability -File share facilitates with profiling +File share in SODA facilitates the user to create file share, set access permission for that file share and user can also create snapshot. SODA provides both CLI and Dashboard to operate or play with file share feature. +Goals of file share in SODA are +- Facilitating File Share Service by providing Standard API to manage multiple vendors, simplify File Share API definition +- File share across the users based on access capability +- File share facilitates with profiling Scope for now is to support only NFS, SMB file share protocols -### Install file share feature with opensds -Follow the wiki link to install opensds https://github.com/sodafoundation/api/wiki/SODA-Projects-Cluster-Installation-through-Ansible +### Install file share feature with SODA +Follow the wiki link to install SODA https://github.com/sodafoundation/api/wiki/SODA-Projects-Cluster-Installation-through-Ansible Make sure backend nfs is enable to use file share feature ###### NFS @@ -25,8 +25,8 @@ enabled_backends: nfs ## Set the environment to start use of file share feature -### OpenSDS CLI -Firstly configure opensds CLI tool: +### SODA CLI +Firstly configure SODA CLI tool: ```bash sudo cp /opt/opensds-hotpot-linux-amd64/bin/osdsctl /usr/local/bin/ @@ -75,15 +75,15 @@ Create snapshot of file share osdsctl fileshare snapshot create -n -d "description of file share snapshot" ``` -### OpenSDS UI -OpenSDS UI dashboard is available at `http://{your_host_ip}:8088`, please login the dashboard using the default admin credentials: `admin/opensds@123`. Create `tenant`, `user`, and `profiles` as admin. +### SODA UI +SODA UI dashboard is available at `http://{your_host_ip}:8088`, please login the dashboard using the default admin credentials: `admin/opensds@123`. Create `tenant`, `user`, and `profiles` as admin. Logout of the dashboard as admin and login the dashboard again as a non-admin user to manage storage resource #### File Share Services * Create a file share -Post login into the OpenSDS UI, File share can be created from: Resource -> File share -> Create +Post login into the SODA UI, File share can be created from: Resource -> File share -> Create ![Fileshare create menu](fileshare_menu.PNG?raw=true) * Create snapshot diff --git a/content/guides/user-guides/multi-cloud/_index.md b/content/guides/user-guides/multi-cloud/_index.md new file mode 100644 index 00000000..ce8204f5 --- /dev/null +++ b/content/guides/user-guides/multi-cloud/_index.md @@ -0,0 +1,111 @@ +--- +title: Multi Cloud +description: "User guide for Multi Cloud service." +weight: 10 +disableToc: false +tags: ["user guide", "multicloud"] +--- + + +## Multi-cloud Local Cluster Installation and Testing +Here are the steps to install SODA Multi Cloud service in a containerized local environment . + +### Pre-config (Ubuntu 16.04/Ubuntu 18.04) +The installation is tested on Ubuntu 16.04 and Ubuntu 18.04, please make sure to use the right one. +Root user is suggested for the installation. + +* packages + +Install following packages: +```bash +apt-get install -y libltdl7 libseccomp2 git curl wget make +``` + +* docker + +Install docker: +```bash +wget https://download.docker.com/linux/ubuntu/dists/xenial/pool/stable/amd64/docker-ce_18.03.1~ce-0~ubuntu_amd64.deb +dpkg -i docker-ce_18.03.1~ce-0~ubuntu_amd64.deb +``` +* golang + +Check golang version information: +SODA multi-cloud needs go version 1.13.x + +Example: +```bash +root@proxy:~# go version +go version go1.13.9 linux/amd64 +``` +You can install golang by executing commands below: +[Using 1.13.9 here for example] +```bash +wget https://storage.googleapis.com/golang/go1.13.9.linux-amd64.tar.gz +tar -C /usr/local -xzf go1.13.9.linux-amd64.tar.gz +echo 'export PATH=$PATH:/usr/local/go/bin' >> /etc/profile +echo 'export GOPATH=$HOME/gopath' >> /etc/profile +source /etc/profile +``` +* docker-compose + +Download and install the latest version of Docker Compose: +```bash +curl -L "https://github.com/docker/compose/releases/download/1.22.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose +chmod +x /usr/local/bin/docker-compose + +# docker-compose --version +docker-compose version 1.22.0, build 1719ceb +``` + +### Install and start SODA Multi-cloud Server +Download the source code: +```bash +mkdir -p /root/gopath/src/github.com/sodafoundation/ +git clone https://github.com/sodafoundation/multi-cloud.git +cd /root/gopath/src/github.com/sodafoundation/multi-cloud +``` + +Make and build the docker image +```bash +make docker +``` + +Execute `docker-compose up -d` to start multi-cloud local cluster, the successful result is supposed to be as follows: +```bash +# docker-compose up -d + +Creating redis ... done +Creating multi-cloud_block_1_87f15fb3fcf4 ... done +Creating tidb ... done +Creating multi-cloud_zookeeper_1_77bbf2cb55a6 ... done +Creating multi-cloud_datastore_1_2341f44ebbba ... done +Creating multi-cloud_file_1_4885d7d3334d ... done +Creating multi-cloud_backend_1_5ab6fd6feed4 ... done +Creating multi-cloud_s3api_1_395c90ae45c3 ... done +Creating multi-cloud_api_1_437a019a9278 ... done +Creating multi-cloud_s3_1_5cf4e4514669 ... done +Creating multi-cloud_kafka_1_ff762483f0b6 ... done +Creating multi-cloud_dataflow_1_592ca1c6f730 ... done +Creating multi-cloud_datamover_1_390d343d0e7c ... done +``` + +To check the installation status run the command `docker ps` +```bash +# docker ps + +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +bbe74a5359eb sodafoundation/multi-cloud-dataflow "/dataflow" 40 seconds ago Up 39 seconds multi-cloud_dataflow_1_8ce4de44c4a7 +e18133da2d9f sodafoundation/multi-cloud-datamover "/datamover" 40 seconds ago Up 39 seconds multi-cloud_datamover_1_1ae5af80e61f +ec8052d3db15 wurstmeister/kafka:2.11-2.0.1 "start-kafka.sh" 41 seconds ago Up 39 seconds 0.0.0.0:9092->9092/tcp multi-cloud_kafka_1_74c5e392fd7d +5fb7560159b2 sodafoundation/multi-cloud-s3 "/initdb.sh" 41 seconds ago Up 40 seconds multi-cloud_s3_1_59cd2512722b +b28213c1ddec sodafoundation/multi-cloud-backend "/backend" 42 seconds ago Up 39 seconds multi-cloud_backend_1_a67a449c92a5 +a47ec4ef770b sodafoundation/multi-cloud-file "/file" 42 seconds ago Up 40 seconds multi-cloud_file_1_cd84c1c9dad3 +be2b170b2d68 sodafoundation/multi-cloud-api "/api" 42 seconds ago Up 41 seconds 0.0.0.0:8090->8090/tcp multi-cloud_s3api_1_4698613dfd2e +f0f2419b98db sodafoundation/multi-cloud-api "/api" 42 seconds ago Up 41 seconds 0.0.0.0:8089->8089/tcp multi-cloud_api_1_aacf7b9a5141 +ad7a85f51343 wurstmeister/zookeeper "/bin/sh -c '/usr/sb…" 42 seconds ago Up 41 seconds 22/tcp, 2888/tcp, 3888/tcp, 0.0.0.0:2181->2181/tcp multi-cloud_zookeeper_1_68df196d327a +3539d1a91298 mongo "docker-entrypoint.s…" 42 seconds ago Up 41 seconds 0.0.0.0:27017->27017/tcp multi-cloud_datastore_1_a2f8fb0deb9d +0722d5174b8f pingcap/tidb:v2.1.16 "/tidb-server --stor…" 42 seconds ago Up 41 seconds 0.0.0.0:4000->4000/tcp, 0.0.0.0:10080->10080/tcp tidb +e03e03d88dcb sodafoundation/multi-cloud-block "/block" 42 seconds ago Up 40 seconds multi-cloud_block_1_7adafa5c5b8d +edc2036f5e1f redis "docker-entrypoint.s…" 42 seconds ago Up 41 seconds 0.0.0.0:6379->6379/tcp redis +``` \ No newline at end of file diff --git a/content/guides/user-guides/object-lifecycle-management/_index.md b/content/guides/user-guides/object-lifecycle-management/_index.md index 0c941163..e0e99c59 100644 --- a/content/guides/user-guides/object-lifecycle-management/_index.md +++ b/content/guides/user-guides/object-lifecycle-management/_index.md @@ -1,5 +1,5 @@ --- -title: Object Lifecycle Management +title: Object Lifecycle description: "User guide for Object Lifecycle Management." weight: 40 disableToc: false @@ -7,15 +7,15 @@ tags: ["user guide", "object lifecycle"] --- ## Introduction to Object lifecycle -OpenSDS is aimed at addressing the storage integration challenges of both the Cloud Native environment and traditional IT environment. OpenSDS multi-cloud allows user to manage distributed cloud environment on a single platform. Object lifecycle management feature gives freedom to user to manage buckets and objects in the cloud using OpenSDS interface. +SODA is aimed at addressing the storage integration challenges of both the Cloud Native environment and traditional IT environment. SODA multi-cloud allows user to manage distributed cloud environment on a single platform. Object lifecycle management feature gives freedom to user to manage buckets and objects in the cloud using SODA interface. ## Getting Started! -This is a guide that shows how to install, configure, and use Object lifecycle management feature in a simple OpenSDS setup. -By following this guide you will be able to install OpenSDS multi-cloud with creating backends and buckets, uploading object and setting up the lifecycle for those objects. +This is a guide that shows how to install, configure, and use Object lifecycle management feature in a simple SODA setup. +By following this guide you will be able to install SODA multi-cloud with creating backends and buckets, uploading object and setting up the lifecycle for those objects. -## Installing Opensds multi-cloud +## Installing SODA multi-cloud -### Download opensds-installer code +### Download SODA-installer code ```cassandraql git clone https://github.com/opensds/opensds-installer.git @@ -35,16 +35,16 @@ gelato_repo_branch: master ``` Detailed instruction is in this link -- [OpenSDS Local Cluster Installation through Ansible On Ubuntu](https://github.com/opensds/opensds/wiki/OpenSDS-Cluster-Installation-through-Ansible) (Recommended) +- [SODA Local Cluster Installation through Ansible On Ubuntu](https://github.com/opensds/opensds/wiki/OpenSDS-Cluster-Installation-through-Ansible) (Recommended) -#### Export required OpenSDS environment variables +#### Export required SODA environment variables ``` export HOST_IP={your_real_host_ip} export OPENSDS_ENDPOINT=http://{{ apiserver_cluster_ip }}:50040 export OPENSDS_AUTH_STRATEGY=keystone export OS_AUTH_URL=http://{{ authchecker_cluster_ip }}/identity ``` -#### Run OpenSDS multi-cloud in docker container +#### Run SODA multi-cloud in docker container ``` docker-compose up -d docker ps @@ -62,9 +62,9 @@ e370acd6c922 mongo "docker-entrypoint.s…" f139d2e383ab opensdsio/multi-cloud-s3 "/s3" 2 minutes ago Up 2 minutes multi-cloud_s3_1_3c7878089fa4 ``` -## Open OpenSDS Object lifecycle management UI +## Open SODA Object lifecycle management UI -OpenSDS Object lifecycle management feature specific UI can be accessed via +SODA Object lifecycle management feature specific UI can be accessed via `http://{your_host_ip}:8088/#/home` @@ -79,7 +79,7 @@ Click on (+) for registering a storage backend ### Create bucket and upload the object After creating new backend follow the steps given below to create a bucket and upload an object in that bucket: -1. Launch Resource from OpenSDS home page +1. Launch Resource from SODA home page 2. Create a new bucket with appropriate backend @@ -103,4 +103,4 @@ After configuring lifecycle in dashboard, a routine scheduler will run and it wi 1. How to check if the lifecycle rule is applied on bucket/object ? Ans: -OpenSDS does not create the rule in the cloud backend (CSP). Once the bucket/object satisfies the rule, OpenSDS will automatically call cloud API and the action will be performed. If there are any errors or issues in rule, user will know at the time of lifecycle action. +SODA does not create the rule in the cloud backend (CSP). Once the bucket/object satisfies the rule, SODA will automatically call cloud API and the action will be performed. If there are any errors or issues in rule, user will know at the time of lifecycle action. diff --git a/content/guides/user-guides/orchestration/_index.md b/content/guides/user-guides/orchestration/_index.md index 12b9b4a7..89384d82 100644 --- a/content/guides/user-guides/orchestration/_index.md +++ b/content/guides/user-guides/orchestration/_index.md @@ -1,5 +1,5 @@ --- -title: Orchestration User Guide +title: Orchestration description: "User guide for Orchestration and automation." weight: 10 disableToc: false @@ -7,10 +7,10 @@ tags: ["user guide", "orchestration"] --- ## Introduction -OpenSDS is aimed at addressing the storage integration challenges of both the Cloud Native environmnet and traditional IT environment.In a distributed environment, the business processes consist of several interconnected steps which may require streamline the process. OpenSDS provides orchestrating these process to ensure accurate and faster execution with minimal manual intervention. The Orchestration framework provides flexibility to use existing workflows or define customized workflows to get the simplied execution of tasks. +SODA is aimed at addressing the storage integration challenges of both the Cloud Native environmnet and traditional IT environment.In a distributed environment, the business processes consist of several interconnected steps which may require streamline the process. SODA provides orchestrating these process to ensure accurate and faster execution with minimal manual intervention. The Orchestration framework provides flexibility to use existing workflows or define customized workflows to get the simplied execution of tasks. ## Intended Readers -OpenSDS users who plan to orchestrate complex tasks in a distributed environment +SODA users who plan to orchestrate complex tasks in a distributed environment ## Purpose @@ -18,27 +18,27 @@ OpenSDS users who plan to orchestrate complex tasks in a distributed environment Please refer to this guide or release notes first for any known issues or workarounds available. Issues related to Orchestration can be raised at https://github.com/opensds/orchestration/issues ## Overview -OpenSDS Capri release provides pre-defined service catalogs. Service catalogs serves specific purpose and abstracts the underlying actions from end-user. End user can create instances of these services and check the status. User can see the entities through OpenSDS dashboard or use OpenSDS CLIs to check it from console. -OpenSDS Orchestration service acts as the facilitator to orchestrate actions between OpenSDS dashboard, Orchestration Manager and the OpenSDS backend. Currently OpenSDS supports StackStorm (https://docs.stackstorm.com/overview.html) as the Orchestration Manager. It uses Mistral workflows in StackStorm. +SODA Capri release provides pre-defined service catalogs. Service catalogs serves specific purpose and abstracts the underlying actions from end-user. End user can create instances of these services and check the status. User can see the entities through SODA dashboard or use SODA CLIs to check it from console. +SODA Orchestration service acts as the facilitator to orchestrate actions between SODA dashboard, Orchestration Manager and the SODA backend. Currently SODA supports StackStorm (https://docs.stackstorm.com/overview.html) as the Orchestration Manager. It uses Mistral workflows in StackStorm. ## Installation -Please refer https://github.com/opensds/orchestration/blob/master/docs/INSTALL.md to install OpenSDS and all the required components of Orchestration. +Please refer https://github.com/opensds/orchestration/blob/master/docs/INSTALL.md to install SODA and all the required components of Orchestration. ## Orchestrating workflows -OpenSDS currently have two types of pre-defined services to orchestrate the workflows. Volume Provisioning and Bucket Migration. -User can define their own customized workflows and write the actions to orchestrate it through OpenSDS. Check 'Customized workflows' section below. -Apart from OpenSDS dashboard, user can directly use the REST Apis to achieve the required tasks. +SODA currently have two types of pre-defined services to orchestrate the workflows. Volume Provisioning and Bucket Migration. +User can define their own customized workflows and write the actions to orchestrate it through SODA. Check 'Customized workflows' section below. +Apart from SODA dashboard, user can directly use the REST Apis to achieve the required tasks. {{% notice note %}} Please refer to the OpenAPI-specs of Orchestration for more details. [Click Here ](http://petstore.swagger.io/?url=https://raw.githubusercontent.com/opensds/orchestration/master/openapi-spec/swagger.yaml) {{% /notice%}} #### Prerequisites - a) OpenSDS is installed and user can log-in into the Dashboard + a) SODA is installed and user can log-in into the Dashboard b) All the required components are installed and running properly ## Services -OpenSDS installation will provide the services available for orchestrating the tasks. +SODA installation will provide the services available for orchestrating the tasks. ![Services](orchestration_services.PNG?raw=true "Services") ### Volume Provisioning @@ -62,7 +62,7 @@ To create a volume and attach it to the required Host, user can create an instan To move objects from bucket of one cloud provider to the other, user can create an instance of "migration bucket" Service under Migration. #### Prerequisites: - a) All the required cloud backends are added into OpenSDS + a) All the required cloud backends are added into SODA b) Required buckets are created in the respective cloud backends. Check this under 'Resource->Buckets' #### Creating an instance @@ -87,8 +87,8 @@ CLI for Orchestration ### Steps to run CLI: -* Deploy OpenSDS (https://github.com/opensds/opensds/wiki) -* Deploy StackStorm with [OpenSDS packs](https://github.com/opensds/orchestration/blob/master/docs/INSTALL.md) +* Deploy SODA (https://github.com/opensds/opensds/wiki) +* Deploy StackStorm with [SODA packs](https://github.com/opensds/orchestration/blob/master/docs/INSTALL.md) * [Start Orchestrator](https://github.com/opensds/orchestration/blob/master/docs/INSTALL.md) * Update input parameters in util.py file (OPENSDS_IP, ORCHESTRATOR_IP, etc.) * Also, if the StackStorm is installed using Docker image, @@ -99,7 +99,7 @@ CLI for Orchestration Orchestration CLI can be used for registering service, Querying service, creating/deleting instance, querying instance -### CLI for OpenSDS Orchestration Manager: +### CLI for SODA Orchestration Manager: usage: orchctl [-h] [-a ADDRESS] [-u USER] [-p PASSWORD] [-t PROJECT_ID] [--orch_ip ORCH_IP] [--orch_port ORCH_PORT] {service,instance,workflow,task} ... @@ -115,12 +115,12 @@ Orchestration CLI can be used for registering service, Querying service, creatin optional arguments: -h, --help show this help message and exit -a ADDRESS, --address ADDRESS - ip address of opensds hotpot - -u USER, --user USER username for opensds hotpot + ip address of SODA hotpot + -u USER, --user USER username for SODA hotpot -p PASSWORD, --password PASSWORD - password for opensds hotpot + password for SODA hotpot -t PROJECT_ID, --project_id PROJECT_ID - project_id for opensds hotpot + project_id for SODA hotpot --orch_ip ORCH_IP Orchestration server ip address --orch_port ORCH_PORT Orchestration server port @@ -204,7 +204,7 @@ Orchestration CLI can be used for registering service, Querying service, creatin ``` ### Customized workflow -If user writes their own Mistral workflows and corresponding actions they can follow following steps to orchestrate it through OpenSDS dashboard. All these steps need to be executed from the OpenSDS ssh console. +If user writes their own Mistral workflows and corresponding actions they can follow following steps to orchestrate it through SODA dashboard. All these steps need to be executed from the SODA ssh console. ### Steps to follow: a) Copy the custom workflow into the '/opt/stackstorm/packs/opensds/actions/workflows/' directory of stackstorm/stackstorm:latest docker container. Ex: docker cp custom_wf.yaml 58d22927c38f:/opt/stackstorm/packs/opensds/actions/workflows/ @@ -229,9 +229,9 @@ If user writes their own Mistral workflows and corresponding actions they can fo ] } {{% notice note %}} -Please note that the **`wfe_type`** should be **`st2`** as OpenSDS supports only **StackStorm** as Orchestration Manager currently. You can specify any existing group like 'Provisioning' or 'Migration' or create a new group altogether. +Please note that the **`wfe_type`** should be **`st2`** as SODA supports only **StackStorm** as Orchestration Manager currently. You can specify any existing group like 'Provisioning' or 'Migration' or create a new group altogether. {{% /notice %}} -Once these steps are done, user can go into the OpenSDS dashboard and create and execute an instance. +Once these steps are done, user can go into the SODA dashboard and create and execute an instance. ### Checking created instances Click on the 'Instances' button on 'Services' page to get the list of all instances of the services being created and its status. diff --git a/content/guides/user-guides/telemetry/_index.md b/content/guides/user-guides/telemetry/_index.md index fd2578a4..0eb3fa2f 100644 --- a/content/guides/user-guides/telemetry/_index.md +++ b/content/guides/user-guides/telemetry/_index.md @@ -1,5 +1,5 @@ --- -title: Telemetry with LVM User Guide +title: Telemetry with LVM description: "User guide for Telemetry with LVM." weight: 10 disableToc: false From 505cd8f3f3ab357954fba8a839aa9a279bb30556 Mon Sep 17 00:00:00 2001 From: rajat verma Date: Tue, 15 Sep 2020 16:19:16 +0530 Subject: [PATCH 02/11] move multi-cloud dev guide to dev section --- .../developer-guides/multi-cloud/_index.md | 111 ++++++++++++++++++ 1 file changed, 111 insertions(+) create mode 100644 content/guides/developer-guides/multi-cloud/_index.md diff --git a/content/guides/developer-guides/multi-cloud/_index.md b/content/guides/developer-guides/multi-cloud/_index.md new file mode 100644 index 00000000..ce8204f5 --- /dev/null +++ b/content/guides/developer-guides/multi-cloud/_index.md @@ -0,0 +1,111 @@ +--- +title: Multi Cloud +description: "User guide for Multi Cloud service." +weight: 10 +disableToc: false +tags: ["user guide", "multicloud"] +--- + + +## Multi-cloud Local Cluster Installation and Testing +Here are the steps to install SODA Multi Cloud service in a containerized local environment . + +### Pre-config (Ubuntu 16.04/Ubuntu 18.04) +The installation is tested on Ubuntu 16.04 and Ubuntu 18.04, please make sure to use the right one. +Root user is suggested for the installation. + +* packages + +Install following packages: +```bash +apt-get install -y libltdl7 libseccomp2 git curl wget make +``` + +* docker + +Install docker: +```bash +wget https://download.docker.com/linux/ubuntu/dists/xenial/pool/stable/amd64/docker-ce_18.03.1~ce-0~ubuntu_amd64.deb +dpkg -i docker-ce_18.03.1~ce-0~ubuntu_amd64.deb +``` +* golang + +Check golang version information: +SODA multi-cloud needs go version 1.13.x + +Example: +```bash +root@proxy:~# go version +go version go1.13.9 linux/amd64 +``` +You can install golang by executing commands below: +[Using 1.13.9 here for example] +```bash +wget https://storage.googleapis.com/golang/go1.13.9.linux-amd64.tar.gz +tar -C /usr/local -xzf go1.13.9.linux-amd64.tar.gz +echo 'export PATH=$PATH:/usr/local/go/bin' >> /etc/profile +echo 'export GOPATH=$HOME/gopath' >> /etc/profile +source /etc/profile +``` +* docker-compose + +Download and install the latest version of Docker Compose: +```bash +curl -L "https://github.com/docker/compose/releases/download/1.22.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose +chmod +x /usr/local/bin/docker-compose + +# docker-compose --version +docker-compose version 1.22.0, build 1719ceb +``` + +### Install and start SODA Multi-cloud Server +Download the source code: +```bash +mkdir -p /root/gopath/src/github.com/sodafoundation/ +git clone https://github.com/sodafoundation/multi-cloud.git +cd /root/gopath/src/github.com/sodafoundation/multi-cloud +``` + +Make and build the docker image +```bash +make docker +``` + +Execute `docker-compose up -d` to start multi-cloud local cluster, the successful result is supposed to be as follows: +```bash +# docker-compose up -d + +Creating redis ... done +Creating multi-cloud_block_1_87f15fb3fcf4 ... done +Creating tidb ... done +Creating multi-cloud_zookeeper_1_77bbf2cb55a6 ... done +Creating multi-cloud_datastore_1_2341f44ebbba ... done +Creating multi-cloud_file_1_4885d7d3334d ... done +Creating multi-cloud_backend_1_5ab6fd6feed4 ... done +Creating multi-cloud_s3api_1_395c90ae45c3 ... done +Creating multi-cloud_api_1_437a019a9278 ... done +Creating multi-cloud_s3_1_5cf4e4514669 ... done +Creating multi-cloud_kafka_1_ff762483f0b6 ... done +Creating multi-cloud_dataflow_1_592ca1c6f730 ... done +Creating multi-cloud_datamover_1_390d343d0e7c ... done +``` + +To check the installation status run the command `docker ps` +```bash +# docker ps + +CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES +bbe74a5359eb sodafoundation/multi-cloud-dataflow "/dataflow" 40 seconds ago Up 39 seconds multi-cloud_dataflow_1_8ce4de44c4a7 +e18133da2d9f sodafoundation/multi-cloud-datamover "/datamover" 40 seconds ago Up 39 seconds multi-cloud_datamover_1_1ae5af80e61f +ec8052d3db15 wurstmeister/kafka:2.11-2.0.1 "start-kafka.sh" 41 seconds ago Up 39 seconds 0.0.0.0:9092->9092/tcp multi-cloud_kafka_1_74c5e392fd7d +5fb7560159b2 sodafoundation/multi-cloud-s3 "/initdb.sh" 41 seconds ago Up 40 seconds multi-cloud_s3_1_59cd2512722b +b28213c1ddec sodafoundation/multi-cloud-backend "/backend" 42 seconds ago Up 39 seconds multi-cloud_backend_1_a67a449c92a5 +a47ec4ef770b sodafoundation/multi-cloud-file "/file" 42 seconds ago Up 40 seconds multi-cloud_file_1_cd84c1c9dad3 +be2b170b2d68 sodafoundation/multi-cloud-api "/api" 42 seconds ago Up 41 seconds 0.0.0.0:8090->8090/tcp multi-cloud_s3api_1_4698613dfd2e +f0f2419b98db sodafoundation/multi-cloud-api "/api" 42 seconds ago Up 41 seconds 0.0.0.0:8089->8089/tcp multi-cloud_api_1_aacf7b9a5141 +ad7a85f51343 wurstmeister/zookeeper "/bin/sh -c '/usr/sb…" 42 seconds ago Up 41 seconds 22/tcp, 2888/tcp, 3888/tcp, 0.0.0.0:2181->2181/tcp multi-cloud_zookeeper_1_68df196d327a +3539d1a91298 mongo "docker-entrypoint.s…" 42 seconds ago Up 41 seconds 0.0.0.0:27017->27017/tcp multi-cloud_datastore_1_a2f8fb0deb9d +0722d5174b8f pingcap/tidb:v2.1.16 "/tidb-server --stor…" 42 seconds ago Up 41 seconds 0.0.0.0:4000->4000/tcp, 0.0.0.0:10080->10080/tcp tidb +e03e03d88dcb sodafoundation/multi-cloud-block "/block" 42 seconds ago Up 40 seconds multi-cloud_block_1_7adafa5c5b8d +edc2036f5e1f redis "docker-entrypoint.s…" 42 seconds ago Up 41 seconds 0.0.0.0:6379->6379/tcp redis +``` \ No newline at end of file From 7cca3ac19b8aaf1191385f9d9ba7f6e59d872a87 Mon Sep 17 00:00:00 2001 From: rajat verma Date: Tue, 15 Sep 2020 16:21:29 +0530 Subject: [PATCH 03/11] removing multi-cloud from user guides section --- .../guides/user-guides/multi-cloud/_index.md | 111 ------------------ 1 file changed, 111 deletions(-) delete mode 100644 content/guides/user-guides/multi-cloud/_index.md diff --git a/content/guides/user-guides/multi-cloud/_index.md b/content/guides/user-guides/multi-cloud/_index.md deleted file mode 100644 index ce8204f5..00000000 --- a/content/guides/user-guides/multi-cloud/_index.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -title: Multi Cloud -description: "User guide for Multi Cloud service." -weight: 10 -disableToc: false -tags: ["user guide", "multicloud"] ---- - - -## Multi-cloud Local Cluster Installation and Testing -Here are the steps to install SODA Multi Cloud service in a containerized local environment . - -### Pre-config (Ubuntu 16.04/Ubuntu 18.04) -The installation is tested on Ubuntu 16.04 and Ubuntu 18.04, please make sure to use the right one. -Root user is suggested for the installation. - -* packages - -Install following packages: -```bash -apt-get install -y libltdl7 libseccomp2 git curl wget make -``` - -* docker - -Install docker: -```bash -wget https://download.docker.com/linux/ubuntu/dists/xenial/pool/stable/amd64/docker-ce_18.03.1~ce-0~ubuntu_amd64.deb -dpkg -i docker-ce_18.03.1~ce-0~ubuntu_amd64.deb -``` -* golang - -Check golang version information: -SODA multi-cloud needs go version 1.13.x - -Example: -```bash -root@proxy:~# go version -go version go1.13.9 linux/amd64 -``` -You can install golang by executing commands below: -[Using 1.13.9 here for example] -```bash -wget https://storage.googleapis.com/golang/go1.13.9.linux-amd64.tar.gz -tar -C /usr/local -xzf go1.13.9.linux-amd64.tar.gz -echo 'export PATH=$PATH:/usr/local/go/bin' >> /etc/profile -echo 'export GOPATH=$HOME/gopath' >> /etc/profile -source /etc/profile -``` -* docker-compose - -Download and install the latest version of Docker Compose: -```bash -curl -L "https://github.com/docker/compose/releases/download/1.22.0/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose -chmod +x /usr/local/bin/docker-compose - -# docker-compose --version -docker-compose version 1.22.0, build 1719ceb -``` - -### Install and start SODA Multi-cloud Server -Download the source code: -```bash -mkdir -p /root/gopath/src/github.com/sodafoundation/ -git clone https://github.com/sodafoundation/multi-cloud.git -cd /root/gopath/src/github.com/sodafoundation/multi-cloud -``` - -Make and build the docker image -```bash -make docker -``` - -Execute `docker-compose up -d` to start multi-cloud local cluster, the successful result is supposed to be as follows: -```bash -# docker-compose up -d - -Creating redis ... done -Creating multi-cloud_block_1_87f15fb3fcf4 ... done -Creating tidb ... done -Creating multi-cloud_zookeeper_1_77bbf2cb55a6 ... done -Creating multi-cloud_datastore_1_2341f44ebbba ... done -Creating multi-cloud_file_1_4885d7d3334d ... done -Creating multi-cloud_backend_1_5ab6fd6feed4 ... done -Creating multi-cloud_s3api_1_395c90ae45c3 ... done -Creating multi-cloud_api_1_437a019a9278 ... done -Creating multi-cloud_s3_1_5cf4e4514669 ... done -Creating multi-cloud_kafka_1_ff762483f0b6 ... done -Creating multi-cloud_dataflow_1_592ca1c6f730 ... done -Creating multi-cloud_datamover_1_390d343d0e7c ... done -``` - -To check the installation status run the command `docker ps` -```bash -# docker ps - -CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES -bbe74a5359eb sodafoundation/multi-cloud-dataflow "/dataflow" 40 seconds ago Up 39 seconds multi-cloud_dataflow_1_8ce4de44c4a7 -e18133da2d9f sodafoundation/multi-cloud-datamover "/datamover" 40 seconds ago Up 39 seconds multi-cloud_datamover_1_1ae5af80e61f -ec8052d3db15 wurstmeister/kafka:2.11-2.0.1 "start-kafka.sh" 41 seconds ago Up 39 seconds 0.0.0.0:9092->9092/tcp multi-cloud_kafka_1_74c5e392fd7d -5fb7560159b2 sodafoundation/multi-cloud-s3 "/initdb.sh" 41 seconds ago Up 40 seconds multi-cloud_s3_1_59cd2512722b -b28213c1ddec sodafoundation/multi-cloud-backend "/backend" 42 seconds ago Up 39 seconds multi-cloud_backend_1_a67a449c92a5 -a47ec4ef770b sodafoundation/multi-cloud-file "/file" 42 seconds ago Up 40 seconds multi-cloud_file_1_cd84c1c9dad3 -be2b170b2d68 sodafoundation/multi-cloud-api "/api" 42 seconds ago Up 41 seconds 0.0.0.0:8090->8090/tcp multi-cloud_s3api_1_4698613dfd2e -f0f2419b98db sodafoundation/multi-cloud-api "/api" 42 seconds ago Up 41 seconds 0.0.0.0:8089->8089/tcp multi-cloud_api_1_aacf7b9a5141 -ad7a85f51343 wurstmeister/zookeeper "/bin/sh -c '/usr/sb…" 42 seconds ago Up 41 seconds 22/tcp, 2888/tcp, 3888/tcp, 0.0.0.0:2181->2181/tcp multi-cloud_zookeeper_1_68df196d327a -3539d1a91298 mongo "docker-entrypoint.s…" 42 seconds ago Up 41 seconds 0.0.0.0:27017->27017/tcp multi-cloud_datastore_1_a2f8fb0deb9d -0722d5174b8f pingcap/tidb:v2.1.16 "/tidb-server --stor…" 42 seconds ago Up 41 seconds 0.0.0.0:4000->4000/tcp, 0.0.0.0:10080->10080/tcp tidb -e03e03d88dcb sodafoundation/multi-cloud-block "/block" 42 seconds ago Up 40 seconds multi-cloud_block_1_7adafa5c5b8d -edc2036f5e1f redis "docker-entrypoint.s…" 42 seconds ago Up 41 seconds 0.0.0.0:6379->6379/tcp redis -``` \ No newline at end of file From c6e01f2030b6fc9244cf93dcdcedea5a9f930797 Mon Sep 17 00:00:00 2001 From: rajat-soda <65751939+rajat-soda@users.noreply.github.com> Date: Thu, 17 Sep 2020 09:09:12 +0530 Subject: [PATCH 04/11] Update content/guides/developer-guides/object-lifecycle-management/_index.md Co-authored-by: Ashit Kumar --- .../developer-guides/object-lifecycle-management/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/guides/developer-guides/object-lifecycle-management/_index.md b/content/guides/developer-guides/object-lifecycle-management/_index.md index 9bcafa4d..f39588b9 100644 --- a/content/guides/developer-guides/object-lifecycle-management/_index.md +++ b/content/guides/developer-guides/object-lifecycle-management/_index.md @@ -7,7 +7,7 @@ tags: ["developer guide", "object lifecycle"] --- ## Overview -This guide is intended for Object Lifecycle feature developers. It provides detailed steps to write new API using SODA. To understand the feature and requirements in detail, please refer to the Object Lifecycle Management [user guide](/guides/user-guides/object-lifecycle-management/) and Object Lifecycle [design spec](https://github.com/opensds/design-specs/blob/master/specs/capri/object_lifecycle_management.md). +This guide is intended for Object Lifecycle feature developers. It provides detailed steps to write new API using SODA. To understand the feature and requirements in detail, please refer to the Object Lifecycle Management [user guide](/guides/user-guides/object-lifecycle-management/) and Object Lifecycle [design spec](https://github.com/sodafoundation/design-specs/blob/master/specs/capri/object_lifecycle_management.md). ## APIs From b18293b658f49b8d7a7e90664d37e392142ca69c Mon Sep 17 00:00:00 2001 From: rajat-soda <65751939+rajat-soda@users.noreply.github.com> Date: Thu, 17 Sep 2020 09:09:22 +0530 Subject: [PATCH 05/11] Update content/guides/developer-guides/object-lifecycle-management/_index.md Co-authored-by: Ashit Kumar --- .../developer-guides/object-lifecycle-management/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/guides/developer-guides/object-lifecycle-management/_index.md b/content/guides/developer-guides/object-lifecycle-management/_index.md index f39588b9..52199823 100644 --- a/content/guides/developer-guides/object-lifecycle-management/_index.md +++ b/content/guides/developer-guides/object-lifecycle-management/_index.md @@ -18,7 +18,7 @@ APIs are a set of functions and procedures that allow for the creation of applic Before starting to write the APIs, it is required to have basic understanding of XML and JSON syntax. #### There are three major steps involved: - a) All APIs go into the 's3' module of the SODA multi-cloud package, i,e. opensds/multi-cloud/api/pkg/s3 directory + a) All APIs go into the 's3' module of the SODA multi-cloud package, i,e. sodafoundation/multi-cloud/api/pkg/s3 directory ======= ## Write new API Before starting to write the APIs, it is required to have basic understanding of XML and JSON syntax. From e6786f8009e8f9915ed1039714e9d7f8880856bb Mon Sep 17 00:00:00 2001 From: rajat-soda <65751939+rajat-soda@users.noreply.github.com> Date: Thu, 17 Sep 2020 09:09:32 +0530 Subject: [PATCH 06/11] Update content/guides/developer-guides/object-lifecycle-management/_index.md Co-authored-by: Ashit Kumar --- .../developer-guides/object-lifecycle-management/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/guides/developer-guides/object-lifecycle-management/_index.md b/content/guides/developer-guides/object-lifecycle-management/_index.md index 52199823..b67fc76b 100644 --- a/content/guides/developer-guides/object-lifecycle-management/_index.md +++ b/content/guides/developer-guides/object-lifecycle-management/_index.md @@ -26,7 +26,7 @@ Before starting to write the APIs, it is required to have basic understanding of ## How to write the APIs ### There are three major steps involved: - a) All APIs goes into the 's3' module of the SODA multi-cloud package, i,e. opensds/multi-cloud/api/pkg/s3 directory + a) All APIs goes into the 's3' module of the SODA multi-cloud package, i,e. sodafoundation/multi-cloud/api/pkg/s3 directory b) The corresponding router for the API are defined same directory. c) For every API there must be a function defined in proto file. Example of adding API router (router.go): From 853791cbd857b9c86a354bfcd6ea2aea90a87185 Mon Sep 17 00:00:00 2001 From: rajat-soda <65751939+rajat-soda@users.noreply.github.com> Date: Thu, 17 Sep 2020 09:09:48 +0530 Subject: [PATCH 07/11] Update content/guides/user-guides/object-lifecycle-management/_index.md Co-authored-by: Ashit Kumar --- .../guides/user-guides/object-lifecycle-management/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/guides/user-guides/object-lifecycle-management/_index.md b/content/guides/user-guides/object-lifecycle-management/_index.md index e0e99c59..edefe465 100644 --- a/content/guides/user-guides/object-lifecycle-management/_index.md +++ b/content/guides/user-guides/object-lifecycle-management/_index.md @@ -18,7 +18,7 @@ By following this guide you will be able to install SODA multi-cloud with creati ### Download SODA-installer code ```cassandraql -git clone https://github.com/opensds/opensds-installer.git +git clone https://github.com/sodafoundation/installer.git cd opensds-installer # Checkout the latest release, give master by default or specify the branch git checkout master From 5354aedf98c60b4fb7c609856f2c459b8319dd2c Mon Sep 17 00:00:00 2001 From: rajat-soda <65751939+rajat-soda@users.noreply.github.com> Date: Thu, 17 Sep 2020 09:10:01 +0530 Subject: [PATCH 08/11] Update content/guides/user-guides/orchestration/_index.md Co-authored-by: Ashit Kumar --- content/guides/user-guides/orchestration/_index.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/content/guides/user-guides/orchestration/_index.md b/content/guides/user-guides/orchestration/_index.md index 89384d82..44201d9d 100644 --- a/content/guides/user-guides/orchestration/_index.md +++ b/content/guides/user-guides/orchestration/_index.md @@ -15,7 +15,7 @@ SODA users who plan to orchestrate complex tasks in a distributed environment ## Purpose ## Problem reporting instructions -Please refer to this guide or release notes first for any known issues or workarounds available. Issues related to Orchestration can be raised at https://github.com/opensds/orchestration/issues +Please refer to this guide or release notes first for any known issues or workarounds available. Issues related to Orchestration can be raised at https://github.com/sodafoundation/orchestration/issues ## Overview SODA Capri release provides pre-defined service catalogs. Service catalogs serves specific purpose and abstracts the underlying actions from end-user. End user can create instances of these services and check the status. User can see the entities through SODA dashboard or use SODA CLIs to check it from console. @@ -247,4 +247,3 @@ Please refer to https://github.com/opensds/orchestration/blob/master/docs/INSTAL ## References [TODO: Add developer guide reference] - From 8594e32b72a0757eacae4efd86bb8434010d6de2 Mon Sep 17 00:00:00 2001 From: rajat-soda <65751939+rajat-soda@users.noreply.github.com> Date: Thu, 17 Sep 2020 09:10:11 +0530 Subject: [PATCH 09/11] Update content/guides/user-guides/orchestration/_index.md Co-authored-by: Ashit Kumar --- content/guides/user-guides/orchestration/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/guides/user-guides/orchestration/_index.md b/content/guides/user-guides/orchestration/_index.md index 44201d9d..f1622085 100644 --- a/content/guides/user-guides/orchestration/_index.md +++ b/content/guides/user-guides/orchestration/_index.md @@ -22,7 +22,7 @@ SODA Capri release provides pre-defined service catalogs. Service catalogs serve SODA Orchestration service acts as the facilitator to orchestrate actions between SODA dashboard, Orchestration Manager and the SODA backend. Currently SODA supports StackStorm (https://docs.stackstorm.com/overview.html) as the Orchestration Manager. It uses Mistral workflows in StackStorm. ## Installation -Please refer https://github.com/opensds/orchestration/blob/master/docs/INSTALL.md to install SODA and all the required components of Orchestration. +Please refer https://github.com/sodafoundation/orchestration/blob/master/docs/INSTALL.md to install SODA and all the required components of Orchestration. ## Orchestrating workflows SODA currently have two types of pre-defined services to orchestrate the workflows. Volume Provisioning and Bucket Migration. From 6beeb5b2e59fd923e0de6ee10800c17ce16913ea Mon Sep 17 00:00:00 2001 From: rajat-soda <65751939+rajat-soda@users.noreply.github.com> Date: Thu, 17 Sep 2020 09:10:24 +0530 Subject: [PATCH 10/11] Update content/guides/user-guides/orchestration/_index.md Co-authored-by: Ashit Kumar --- content/guides/user-guides/orchestration/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/guides/user-guides/orchestration/_index.md b/content/guides/user-guides/orchestration/_index.md index f1622085..114e01d5 100644 --- a/content/guides/user-guides/orchestration/_index.md +++ b/content/guides/user-guides/orchestration/_index.md @@ -88,7 +88,7 @@ CLI for Orchestration ### Steps to run CLI: * Deploy SODA (https://github.com/opensds/opensds/wiki) -* Deploy StackStorm with [SODA packs](https://github.com/opensds/orchestration/blob/master/docs/INSTALL.md) +* Deploy StackStorm with [SODA packs](https://github.com/sodafoundation/orchestration/blob/master/docs/INSTALL.md) * [Start Orchestrator](https://github.com/opensds/orchestration/blob/master/docs/INSTALL.md) * Update input parameters in util.py file (OPENSDS_IP, ORCHESTRATOR_IP, etc.) * Also, if the StackStorm is installed using Docker image, From 9fb4efbd4f6e1a3e787a7c61d80455ea04552f0a Mon Sep 17 00:00:00 2001 From: rajat verma Date: Thu, 17 Sep 2020 09:28:31 +0530 Subject: [PATCH 11/11] add docs.sodafoundation link for Deploy SODA --- content/guides/user-guides/orchestration/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/guides/user-guides/orchestration/_index.md b/content/guides/user-guides/orchestration/_index.md index 114e01d5..6818b73c 100644 --- a/content/guides/user-guides/orchestration/_index.md +++ b/content/guides/user-guides/orchestration/_index.md @@ -87,7 +87,7 @@ CLI for Orchestration ### Steps to run CLI: -* Deploy SODA (https://github.com/opensds/opensds/wiki) +* [Deploy SODA](https://docs.sodafoundation.io/soda-gettingstarted/quickstart/) * Deploy StackStorm with [SODA packs](https://github.com/sodafoundation/orchestration/blob/master/docs/INSTALL.md) * [Start Orchestrator](https://github.com/opensds/orchestration/blob/master/docs/INSTALL.md) * Update input parameters in util.py file (OPENSDS_IP, ORCHESTRATOR_IP, etc.)