diff --git a/.hugo_build.lock b/.hugo_build.lock new file mode 100644 index 00000000..e69de29b diff --git a/README.md b/README.md index 0b2fb196..66ab756d 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ SODA Documentation provides documentation for SODA Foundation and all the SODA Core projects. -This repo consists of all the code to generate the documentation website and repsective contents. ([https://docs.sodafoundation.io](https://docs.sodafoundation.io/)) +This repo consists of all the code to generate the Documentation [Website](https://docs.sodafoundation.io/) and its repsective contents. This is maintained by SODA Foundation directly. diff --git a/content/_index.en.md b/content/_index.en.md index a13308c8..8deb2487 100644 --- a/content/_index.en.md +++ b/content/_index.en.md @@ -2,11 +2,10 @@ title: "SODA Foundation Documentation" --- -# Welcome to SODA Foundation documentation! +# Welcome to SODA Foundation documentation [SODA Foundation](http://github.com/sodafoundation) is an open source project under Linux Foundation that aims to foster an ecosystem of open source data management and storage software for data autonomy. SODA Foundation offers a neutral forum for cross-projects collaboration and integration and provides end users quality end-to-end solutions. - ## Table of Contents {{% children depth="2" %}} diff --git a/content/api-specs/_index.md b/content/api-specs/_index.md index 9948505e..a5099290 100644 --- a/content/api-specs/_index.md +++ b/content/api-specs/_index.md @@ -1,7 +1,7 @@ --- title: SODA API Specification description: "Provides SODA API Standards for Data and Storage" -weight: 3 +weight: 5 disableToc: false --- diff --git a/content/architecture/_index.md b/content/architecture/_index.md index 559811db..411f6b44 100644 --- a/content/architecture/_index.md +++ b/content/architecture/_index.md @@ -1,7 +1,7 @@ --- title: SODA Architecture description: "" -weight: 3 +weight: 4 disableToc: false --- diff --git a/content/community/_index.md b/content/community/_index.md index b4359e4f..2e07d863 100644 --- a/content/community/_index.md +++ b/content/community/_index.md @@ -1,7 +1,7 @@ --- title: Community description: "SODA Foundation Introduction" -weight: 9 +weight: 11 disableToc: false --- SODA Foundation Community comprises of Partnering Organizations, Collaborating Organizations, Developers, Supporters and more. There are different channels through which you can be part of this community to collaborate, contribute and grow. diff --git a/content/feedback/_index.md b/content/feedback/_index.md index b95b7c6b..27702d9d 100644 --- a/content/feedback/_index.md +++ b/content/feedback/_index.md @@ -1,7 +1,7 @@ --- title: Feedback description: "Feedback or Suggestions" -weight: 10 +weight: 12 disableToc: false --- ## General Feedback diff --git a/content/governance/_index.md b/content/governance/_index.md index f4b83831..0fee5248 100644 --- a/content/governance/_index.md +++ b/content/governance/_index.md @@ -1,7 +1,7 @@ --- title: Governance description: "SODA Foundation Introduction" -weight: 7 +weight: 9 disableToc: false --- SODA Foundation is overseen by the Governing Board and supported by the Technical Steering Committee (TSC), End User Advisory Committee (EUAC) and Outreach Committee (OC). diff --git a/content/guides/_index.md b/content/guides/_index.md index 2429165c..1aad55d1 100644 --- a/content/guides/_index.md +++ b/content/guides/_index.md @@ -1,10 +1,10 @@ --- title: Guides and Docs description: "All the guides and detailed documentation" -weight: 6 +weight: 3 disableToc: false --- This section provides different guides and documentaions, like user guides, developer guides, integration guides, tutorials and more. -{{%children style="h3" description="true" %}} +{{%children style="h3" description="true"%}} diff --git a/content/guides/installer-guides/_index.md b/content/guides/installer-guides/_index.md deleted file mode 100644 index 7086e225..00000000 --- a/content/guides/installer-guides/_index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: SODA Installer Guides -description: "All the installation guides and documentation" -weight: 10 -disableToc: false ---- -## SODA Installers - -SODA Foundation Release supports different kinds of installation methods. -You can find the details of the SODA Installer as below: - - - [The Installer Guides](https://docs.sodafoundation.io/soda-gettingstarted/installation/) - - [SODA Installer Source Code](https://github.com/sodafoundation/installer) - -{{%children style="h3" description="true" %}} - diff --git a/content/guides/user-guides/_index.md b/content/guides/user-guides/_index.md deleted file mode 100644 index 5504f484..00000000 --- a/content/guides/user-guides/_index.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: User Guides -description: "The user guides of features of different SODA Projects" -weight: 20 -disableToc: true ---- - -This section provides User Guides for various features from different projects of SODA Foundation. Focuses mainly on the usage of the features in these document. If you are interested to develop/port etc, please refer the developer guides or contact us through any of the technical channels. - -{{%children style="h3" description="true" %}} diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-1.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-1.png deleted file mode 100644 index bc27381f..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-1.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-10.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-10.png deleted file mode 100644 index c00c406d..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-10.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-11.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-11.png deleted file mode 100644 index ce4a3f69..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-11.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-12.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-12.png deleted file mode 100644 index 3d1d2551..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-12.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-13.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-13.png deleted file mode 100644 index 3d1d2551..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-13.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-14.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-14.png deleted file mode 100644 index 1f8d2655..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-14.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-15.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-15.png deleted file mode 100644 index fd4429fa..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-15.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-16.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-16.png deleted file mode 100644 index f2944bf9..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-16.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-17.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-17.png deleted file mode 100644 index c526f3af..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-17.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-18.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-18.png deleted file mode 100644 index 8095d5c8..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-18.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-19.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-19.png deleted file mode 100644 index 7e780b83..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-19.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-2.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-2.png deleted file mode 100644 index 121dd946..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-2.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-20.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-20.png deleted file mode 100644 index 95c16e9d..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-20.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-21-1.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-21-1.png deleted file mode 100644 index 97af89ae..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-21-1.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-21.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-21.png deleted file mode 100644 index 12d40de6..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-21.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-22.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-22.png deleted file mode 100644 index e1623f2e..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-22.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-23.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-23.png deleted file mode 100644 index 041f7381..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-23.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-24.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-24.png deleted file mode 100644 index 341c4bc1..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-24.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-25.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-25.png deleted file mode 100644 index 7769b8ab..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-25.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-26.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-26.png deleted file mode 100644 index f91f56ec..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-26.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-27-1.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-27-1.png deleted file mode 100644 index c43f9128..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-27-1.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-27.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-27.png deleted file mode 100644 index 7bce2357..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-27.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-28-1.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-28-1.png deleted file mode 100644 index f2995fb0..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-28-1.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-28.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-28.png deleted file mode 100644 index 2e238802..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-28.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-29-1.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-29-1.png deleted file mode 100644 index 725d6ef7..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-29-1.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-29.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-29.png deleted file mode 100644 index 68397efc..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-29.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-3.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-3.png deleted file mode 100644 index 854b34b8..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-3.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-30-1.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-30-1.png deleted file mode 100644 index a8a5aaf6..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-30-1.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-30.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-30.png deleted file mode 100644 index 331a37b7..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-30.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-31-1.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-31-1.png deleted file mode 100644 index 70d9e728..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-31-1.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-31.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-31.png deleted file mode 100644 index 917eb78e..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-31.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-32.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-32.png deleted file mode 100644 index 8177063b..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-32.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-33.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-33.png deleted file mode 100644 index 19aec54f..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-33.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-34.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-34.png deleted file mode 100644 index 8bca4093..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-34.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-35.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-35.png deleted file mode 100644 index 35ef5e6a..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-35.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-36.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-36.png deleted file mode 100644 index c4ad39a5..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-36.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-37.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-37.png deleted file mode 100644 index 56f6d63d..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-37.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-38.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-38.png deleted file mode 100644 index 2b08f1a8..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-38.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-39.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-39.png deleted file mode 100644 index 33430fd1..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-39.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-4.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-4.png deleted file mode 100644 index a08853cd..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-4.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-40.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-40.png deleted file mode 100644 index c451e115..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-40.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-41.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-41.png deleted file mode 100644 index a7969282..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-41.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-42.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-42.png deleted file mode 100644 index c7ecaad2..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-42.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-43.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-43.png deleted file mode 100644 index 2edacf7d..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-43.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-44.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-44.png deleted file mode 100644 index ae0468f5..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-44.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-45.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-45.png deleted file mode 100644 index 6623ba72..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-45.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-46.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-46.png deleted file mode 100644 index 153c2c30..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-46.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-47.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-47.png deleted file mode 100644 index aa20913a..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-47.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-48.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-48.png deleted file mode 100644 index 8e5f1b60..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-48.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-49.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-49.png deleted file mode 100644 index e2479020..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-49.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-5.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-5.png deleted file mode 100644 index 82a462d8..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-5.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-50.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-50.png deleted file mode 100644 index 53fccb45..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-50.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-51.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-51.png deleted file mode 100644 index ae532d45..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-51.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-52.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-52.png deleted file mode 100644 index 93cce2c4..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-52.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-6.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-6.png deleted file mode 100644 index 6b7af299..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-6.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-7.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-7.png deleted file mode 100644 index af0cb40e..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-7.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-8.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-8.png deleted file mode 100644 index d0246dfb..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-8.png and /dev/null differ diff --git a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-9.png b/content/guides/user-guides/delfin/dashboard/delfin-user-guide-9.png deleted file mode 100644 index cf14932c..00000000 Binary files a/content/guides/user-guides/delfin/dashboard/delfin-user-guide-9.png and /dev/null differ diff --git a/content/projects/_index.md b/content/projects/_index.md index 2ca3948e..61e9f822 100644 --- a/content/projects/_index.md +++ b/content/projects/_index.md @@ -1,97 +1,29 @@ --- -title: SODA Projects +title: SODA Framework Projects description: "This page provides the details of SODA Projects" -weight: 4 +weight: 3 disableToc: false --- -[SODA Foundation](https://sodafoundation.io) is a home for multiple projects for building a unified data framework to support various data and storage solutions. Here is a brief description of all the projects maintained by SODA Foundation. +[SODA Foundation](https://sodafoundation.io) is a home for multiple projects for building a unified data framework to support various data and storage solutions. Here is a brief description of all the projects maintained by SODA Foundation. ![SODA Projects Architecture](soda-project-architecture.png) -- ### SODA Dashboard - SODA Dashboard provides a unified interface to the underlying capabilities from the SODA Framework components. This dashboard is built mainly to illustrate/showcase various use cases that could run on SODA ecosystem projects. +{{%children style="h3" description="true" %}} - Technically, it is a direct client to SODA API and other projects which are getting integrated to SODA Ecosystem. It will be reference integration of all the underlying projects to realize various use cases. - - Every SODA release will have the SODA Dashboard with new use cases integrated based on the new features or projects integrated to SODA project ecosystem. - - [Source Code Repository](https://github.com/sodafoundation/dashboard) - -- ### SODA Delfin - delfin (Dolphin in Spanish!), the SODA Infrastructure Manager project is an open source project to provide unified, intelligent and scalable resource management, alert and performance monitoring. It covers the resource management of all the backends & other infrastructures under SODA deployment. It also provides alert management and metric data (performance/health) for monitoring and further analysis. - - It provides a scalable framework where more and more backends as well as client exporters can be added. This enables to add more storage and infrastructure backends and also support different management clients for monitoring and health prediction. - - It provides unified APIs to access, export and connect with clients as well as a set of interfaces for various driver additions. - The vision is to build a unified intelligent and scalable infrastructure management framework for resource management (config, add, remove, update), alert management and performance metrics management with standardized APIs across any storage and application platforms with connectors for data analysis and prediction. - - [Source Code Repository](https://github.com/sodafoundation/delfin) - - [Support Matrix](https://docs.sodafoundation.io/support-matrix/delfin/) - -- ### SODA API - The SODA API, Provides the standardization for Data / Storage Management APIs. At present, block and file APIs for key features of data management (provisioning, migration, fileshare, etc) are supported. - - This is the key external interface to platforms which can do a seamless integration with heterogeneous storage backends. - - Users can develop SODA North-Bound Plugins (SODA NBP) under SODA NBP project to connect any platform or application solutions to SODA API from north for all storage/data requirements. - - This is envisioned to be the reference implementation of SODA Data Standard API Specification, with contributions from industry partners and standards bodies. At that stage, this layer will upgraded to support Block, File and Object APIs across the Edge, Core and Cloud. - - [Source Code Repository](https://github.com/sodafoundation/api) - -- ### SODA Controller - The SODA Controller, provides metadata management, control/configurations, scheduler and all such book-keeping features and utilities. In the API flow from SODA API to SODA Dock, controller plays a critical role for all the API flow management and tracking to handle all the state machine and metadata management requirements. This is a layer to keep addons to new facilities or utilities for the SODA platform. - - At present, this layer can be optional or similar modules can be used from users(if they have such software components). However, users need to integrate the Controller modules with SODA API and SODA Dock. - - The Controller interfaces with SODA API and SODA Dock. - - [Source Code Repository](https://github.com/sodafoundation/controller) - -- ### SODA Dock - SODA Dock is a docking station for heterogeneous storage backends! This is where all the different storage vendors drivers for various storage backend models get attached. - - The goal is to make most of the protocols and backends supported as close as ‘plug n play’. Currently, each storage backend needs a thin, easy to develop SODA Driver Plugin to connect the storage backend to the Dock. SODA Driver Plugin and Storage vendor driver together it can be called SODA Driver for xxx vendor yy model storage.SODA Driver can support one or more or multiple classes of storage backends. - - To connect more and more cloud-native storages seamlessly with the SODA Platform,there is an experimental feature for CSI PlugNPlay is developed. This will immediately enable any CSI driver to work with SODA using a single SODA CSI plugin for the application platform (like Kubernetes), in turn, support all the storage vendors supporting CSI. - - SODA Dock can interface directly to SODA API or via Controller. However, it is recommended through the controller for a complete end to end solution, as it can provide the metadata management, handling multiple docks, etc. - - The roadmap is to have multiple instances, multi-driver docks to support multi-cluster, multi-platform, or multi-cloud scenarios in the future. - - [Source Code Repository](https://github.com/sodafoundation/dock) - ### SODA Plugin + SODA Plugins enable awareness and seamless integration between SODA and compute platforms or application frameworks. SODA provides plugins for Kubernetes, OpenStack and VMWare. - + [SODA Cloud Native Storage For Kubernetes CSI](https://sodafoundation.io/projects/soda-plugins/kubernetes/) [SODA Cinder Block & Manila File Services For OpenStack](https://sodafoundation.io/projects/soda-plugins/openstack/) [SODA VASA For Vmware](https://sodafoundation.io/projects/soda-plugins/vmware/) - [Support Matrix](https://docs.sodafoundation.io/support-matrix/nbp/) - -- ### SODA Multicloud - SODA Multicloud provides a cloud vendor agnostic data management for hybrid cloud, intercloud, or intracloud. The goal is to provide a unified interface to support file, block,and object services across multiple cloud vendors. It can be hosted on-premise or in the cloud. - - For object data management, it provides a backend manager which is S3 compatible APIs to connect with any cloud vendors. Currently, MS Azure, GCP, AWS, Huawei, IBM, Alibaba backends are supported and getting updated with new backends regularly. - - It also supports Ceph backed to enable on-prem. China Unicom has integrated their YIG project into SODA Multicloud, enabling Ceph to be used as a massively scalable backend object storage. - - SODA multi-cloud also supports creating Storage Service Plans(SSP) for creating tenant based access to multi-cloud storages. - - Basic file service support is added for AWS, Azure, GCP and Huawei and basic block service support is added for AWS EBS and Huawei. - - The technical team is exploring to extend SODA Multicloud and other key layers of SODA into a distributed data store which can support block, file and object data management across the edge, on-premise, and cloud - - [Source Code Repository](https://github.com/sodafoundation/multi-cloud) - - [Support Matrix](https://docs.sodafoundation.io/support-matrix/multi-cloud/) + [Support Matrix](https://docs.sodafoundation.io/projects/nbp/support-matrix/) - - Source code for other projects are maintained under [SODA Foundation github organization](https://github.com/sodafoundation) - +- Source code for other projects are maintained under [SODA Foundation github organization](https://github.com/sodafoundation) diff --git a/content/projects/dashboard/_index.md b/content/projects/dashboard/_index.md new file mode 100644 index 00000000..ec8a56cf --- /dev/null +++ b/content/projects/dashboard/_index.md @@ -0,0 +1,21 @@ +--- +title: SODA Dashboard +menuTitle: Dashboard +description: "Start here if you want to know about developing for Dashboard" +weight: 4 +disableToc: true +--- + +This section provides Developer Guide for Dashboard UI of SODA Foundation. Focuses mainly on the development based on these features. If you are interested in just using the features, please refer the user guides or contact us through any of the technical channels. + +### SODA Dashboard + +SODA Dashboard provides a unified interface to the underlying capabilities from the SODA Framework components. This dashboard is built mainly to illustrate/showcase various use cases that could run on SODA ecosystem projects. + +Technically, it is a direct client to SODA API and other projects which are getting integrated to SODA Ecosystem. It will be reference integration of all the underlying projects to realize various use cases. + +Every SODA release will have the SODA Dashboard with new use cases integrated based on the new features or projects integrated to SODA project ecosystem. + +[Source Code Repository](https://github.com/sodafoundation/dashboard) + +{{%children style="h3" description="true" %}} diff --git a/content/guides/developer-guides/dashboard/_index.md b/content/projects/dashboard/developer-guide/_index.md similarity index 99% rename from content/guides/developer-guides/dashboard/_index.md rename to content/projects/dashboard/developer-guide/_index.md index 341be8df..ecfa3f1f 100644 --- a/content/guides/developer-guides/dashboard/_index.md +++ b/content/projects/dashboard/developer-guide/_index.md @@ -1,13 +1,12 @@ --- -title: Dashboard UI +title: Developer Guide description: "SODA Dashboard Development Guide" weight: 10 disableToc: false tags: ["developer guide", "dashboard"] --- -SODA dashboard uses the front-end development framework Angular5 (https://angular.io/) and relies on PrimeNG UI Components (https://www.primefaces.org/primeng/). - +SODA dashboard uses the front-end development framework Angular5 (https://angular.io/) and relies on PrimeNG UI Components (https://www.primefaces.org/primeng/). ## Prerequisite ### SODA Dashboard development requires a working SODA installation. @@ -483,4 +482,4 @@ http://localhost/ SODA Dashboard makes use of [PrimeNG v5.2.7 ](https://github.com/primefaces/primeng/tree/5.2.7) components. All the components that are used in the UI are included in the `src\app\components` folder. -The detailed documentation with API interface and usage examples for the components can be found [here](https://www.primefaces.org/primeng/v5.2.7/#/) +The detailed documentation with API interface and usage examples for the components can be found [here](https://www.primefaces.org/primeng/v5.2.7/#/) \ No newline at end of file diff --git a/content/projects/delfin/_index.md b/content/projects/delfin/_index.md new file mode 100644 index 00000000..63b2cbab --- /dev/null +++ b/content/projects/delfin/_index.md @@ -0,0 +1,24 @@ +--- +title: SODA Delfin +menuTitle: Delfin +description: "All guides for the Delfin project can be found here" +weight: 2 +disableToc: false +tags: ["user guide", "delfin", "dashboard"] +--- +This section provides Guides for various features from the Delfin project of SODA Foundation. If you are interested to develop/port, please refer the developer guides or contact us through any of the technical channels. + +### SODA Delfin + +Delfin (Dolphin in Spanish!), the SODA Infrastructure Manager project is an open source project to provide unified, intelligent and scalable resource management, alert and performance monitoring. It covers the resource management of all the backends & other infrastructures under SODA deployment. It also provides alert management and metric data (performance/health) for monitoring and further analysis. + +It provides a scalable framework where more and more backends as well as client exporters can be added. This enables to add more storage and infrastructure backends and also support different management clients for monitoring and health prediction. + +It provides unified APIs to access, export and connect with clients as well as a set of interfaces for various driver additions. +The vision is to build a unified intelligent and scalable infrastructure management framework for resource management (config, add, remove, update), alert management and performance metrics management with standardized APIs across any storage and application platforms with connectors for data analysis and prediction. + +[Source Code Repository](https://github.com/sodafoundation/delfin) + +[Support Matrix](https://docs.sodafoundation.io/projects/delfin/support-matrix/) +{{%children style="h3" description="true" %}} + \ No newline at end of file diff --git a/content/guides/developer-guides/delfin/delfin-kubernetes-guide/_index.md b/content/projects/delfin/developer-guides/Delfin-kubernetes-guide/_index.md similarity index 100% rename from content/guides/developer-guides/delfin/delfin-kubernetes-guide/_index.md rename to content/projects/delfin/developer-guides/Delfin-kubernetes-guide/_index.md diff --git a/content/guides/developer-guides/delfin/driver-developer-guide/_index.md b/content/projects/delfin/developer-guides/Driver-developer-guide/_index.md similarity index 99% rename from content/guides/developer-guides/delfin/driver-developer-guide/_index.md rename to content/projects/delfin/developer-guides/Driver-developer-guide/_index.md index 5a5b3657..0fc76e2c 100644 --- a/content/guides/developer-guides/delfin/driver-developer-guide/_index.md +++ b/content/projects/delfin/developer-guides/Driver-developer-guide/_index.md @@ -752,4 +752,3 @@ Delfin performance metrics collection interfaces (`get_capability()` & `collect_ Pluggable design of Driver Manager makes it easy to add third party drivers expanding infrastructure management capabilities of SODA Delfin to multiple storage backends. - diff --git a/content/guides/developer-guides/delfin/_index.md b/content/projects/delfin/developer-guides/_index.md similarity index 83% rename from content/guides/developer-guides/delfin/_index.md rename to content/projects/delfin/developer-guides/_index.md index 0f594e29..1a293c95 100644 --- a/content/guides/developer-guides/delfin/_index.md +++ b/content/projects/delfin/developer-guides/_index.md @@ -1,11 +1,11 @@ --- title: Delfin Developer Guides -menuTitle: Delfin +menuTitle: Developer Guide description: "This section will contain developer guides for delfin project" -weight: 30 +weight: 10 disableToc: true --- This section provides Developer Guides for various features from delfin project of SODA Foundation. Focuses mainly on the development based on these features. If you are interested in just using the features, please refer the user guides or contact us through any of the technical channels. -{{%children style="h3" description="true" %}} +{{%children style="h3" description="true" %}} diff --git a/content/guides/developer-guides/delfin/exporter-developer-guide/_index.md b/content/projects/delfin/developer-guides/exporter-developer-guide/_index.md similarity index 99% rename from content/guides/developer-guides/delfin/exporter-developer-guide/_index.md rename to content/projects/delfin/developer-guides/exporter-developer-guide/_index.md index dd901b75..010976f4 100644 --- a/content/guides/developer-guides/delfin/exporter-developer-guide/_index.md +++ b/content/projects/delfin/developer-guides/exporter-developer-guide/_index.md @@ -193,6 +193,7 @@ Register storage (fake storage for test) ``` + Sync alerts ```bash diff --git a/content/support-matrix/delfin/_index.md b/content/projects/delfin/support-matrix/_index.md similarity index 99% rename from content/support-matrix/delfin/_index.md rename to content/projects/delfin/support-matrix/_index.md index 8b266ae3..c78f22e7 100644 --- a/content/support-matrix/delfin/_index.md +++ b/content/projects/delfin/support-matrix/_index.md @@ -1,8 +1,8 @@ --- -title: Delfin -menuTitle: Delfin +title: Support Matrix +menuTitle: Support Matrix description: "Support matrix data for drivers of Delfin project" -weight: 10 +weight: 30 disableToc: false tags: ["support matrix", "delfin", "drivers"] --- diff --git a/content/support-matrix/delfin/add-driver-support/_index.md b/content/projects/delfin/support-matrix/add-driver-support/_index.md similarity index 100% rename from content/support-matrix/delfin/add-driver-support/_index.md rename to content/projects/delfin/support-matrix/add-driver-support/_index.md diff --git a/content/support-matrix/delfin/dell-emc/_index.md b/content/projects/delfin/support-matrix/dell-emc/_index.md similarity index 100% rename from content/support-matrix/delfin/dell-emc/_index.md rename to content/projects/delfin/support-matrix/dell-emc/_index.md diff --git a/content/support-matrix/delfin/dell-emc/vmax/_index.md b/content/projects/delfin/support-matrix/dell-emc/vmax/_index.md similarity index 100% rename from content/support-matrix/delfin/dell-emc/vmax/_index.md rename to content/projects/delfin/support-matrix/dell-emc/vmax/_index.md diff --git a/content/support-matrix/delfin/huawei/_index.md b/content/projects/delfin/support-matrix/huawei/_index.md similarity index 100% rename from content/support-matrix/delfin/huawei/_index.md rename to content/projects/delfin/support-matrix/huawei/_index.md diff --git a/content/support-matrix/delfin/huawei/oceanstor/_index.md b/content/projects/delfin/support-matrix/huawei/oceanstor/_index.md similarity index 100% rename from content/support-matrix/delfin/huawei/oceanstor/_index.md rename to content/projects/delfin/support-matrix/huawei/oceanstor/_index.md diff --git a/content/guides/user-guides/delfin/_index.md b/content/projects/delfin/user-guides/_index.md similarity index 78% rename from content/guides/user-guides/delfin/_index.md rename to content/projects/delfin/user-guides/_index.md index 99a680d4..d45ae7cd 100644 --- a/content/guides/user-guides/delfin/_index.md +++ b/content/projects/delfin/user-guides/_index.md @@ -1,11 +1,11 @@ --- -title: Delfin -menuTitle: Delfin +title: User Guides +menuTitle: User Guides description: "All user guides for the Delfin project can be found here" -weight: 10 +weight: 20 disableToc: false tags: ["user guide", "delfin", "dashboard"] --- This section provides User Guides for various features from the Delfin project of SODA Foundation. If you are interested to develop/port, please refer the developer guides or contact us through any of the technical channels. -{{%children style="h3" description="true" %}} \ No newline at end of file +{{%children style="h3" description="true" %}} diff --git a/content/guides/user-guides/delfin/api-clients/_index.md b/content/projects/delfin/user-guides/api-clients/_index.md similarity index 98% rename from content/guides/user-guides/delfin/api-clients/_index.md rename to content/projects/delfin/user-guides/api-clients/_index.md index e2fefc18..aa5d32e3 100644 --- a/content/guides/user-guides/delfin/api-clients/_index.md +++ b/content/projects/delfin/user-guides/api-clients/_index.md @@ -25,7 +25,7 @@ This document is to help third party clients who wants to integrate [Delfin](htt - Python 3.6+ - Delfin and its dependencies [installed](https://docs.sodafoundation.io/soda-gettingstarted/installation) -##### Installation Note: +##### Installation Note - Delfin supports Ansible and Docker based installation for its deployment with all dependencies - If external exporter configurations are enabled (Prometheus, Kafka or Aler Manager), SODA Ansible Installer option, 'SRM_Toolchain' needs to be enabled for installation of Kafka, Prometheus & Alert Manager tools. Default Delfin installation will not install these exporters @@ -42,7 +42,6 @@ Important configurations that users want change may be, - Cryptor used for encrypt sensitive data - Certificate file paths to interface with storage backends - #### A typical configuration contains items listed below |Category |Name | Default value | Description | @@ -65,8 +64,6 @@ Important configurations that users want change may be, | | alert_manager_port | '9093' | Alert Manager PORT | | | | | | - - #### Example config file ``` ini @@ -100,7 +97,6 @@ alert_manager_host = '' alert_manager_port = '9093' ``` - ## Delfin APIs and Usage Detailed specification of REST APIs, Schemas and Requests/Responses are provided in the [OpenAPI Spec](https://github.com/sodafoundation/delfin/blob/master/openapi-spec/swagger.yaml) @@ -304,6 +300,6 @@ A Sample exporter implementation is provided in Delfin repo for reference. Also, - [Delfin Design Spec](https://github.com/sodafoundation/architecture-analysis/blob/master/arch-design/delfin/SODA_InfrastructureManagerDesign.md) - [Delfin OpenAPI Spec](https://github.com/sodafoundation/delfin/blob/master/openapi-spec/swagger.yaml) - [Delfin Exporter writing guide](https://docs.sodafoundation.io/guides/developer-guides/delfin/exporter-developer-guide/) -- [Delfin Developer Guide](https://docs.sodafoundation.io/guides/developer-guides/delfin/) +- [Delfin Developer Guide](https://docs.sodafoundation.io/projects/delfin/developer-guides/) - [Alert Spec](https://github.com/sodafoundation/architecture-analysis/blob/master/specs/SIM/alert_manager/SODA_AlertManagerDesign.md) -- [Performance metrics Spec](https://github.com/sodafoundation/architecture-analysis/pull/77) +- [Performance metrics Spec](https://github.com/sodafoundation/architecture-analysis/pull/77) \ No newline at end of file diff --git a/content/guides/user-guides/delfin/dashboard/_index.md b/content/projects/delfin/user-guides/dashboard/_index.md similarity index 100% rename from content/guides/user-guides/delfin/dashboard/_index.md rename to content/projects/delfin/user-guides/dashboard/_index.md index e7268b2f..20584a1f 100644 --- a/content/guides/user-guides/delfin/dashboard/_index.md +++ b/content/projects/delfin/user-guides/dashboard/_index.md @@ -12,6 +12,7 @@ delfin (Dolphin in Spanish!), the SODA Infrastructure Manager project is an open It provides unified APIs to access, export and connect with clients as well as a set of interfaces for various driver additions. These APIs combined with the SODA Dashboard provide a graphical interface that allows users to manage storage backends and visualize the metrics and health. ### Delfin Features + - [Register a Storage Device](#register-storage-device) - [REST Access](#rest-access) - [SSH Access](#ssh-access) @@ -366,4 +367,3 @@ This Alertmanager link in the sidebar menu launches the Alertmanager UI. - diff --git a/content/support-matrix/nbp/_index.md b/content/projects/nbp/_index.md similarity index 96% rename from content/support-matrix/nbp/_index.md rename to content/projects/nbp/_index.md index f4e8558c..e62a1828 100644 --- a/content/support-matrix/nbp/_index.md +++ b/content/projects/nbp/_index.md @@ -1,5 +1,5 @@ --- -title: NBP +title: SODA NBP menuTitle: NBP description: "All user guides for the North Bound Plugin(NBP) project can be found here" weight: 15 diff --git a/content/support-matrix/nbp/csi-pnp/_index.md b/content/projects/nbp/support-matrix/_index.md similarity index 97% rename from content/support-matrix/nbp/csi-pnp/_index.md rename to content/projects/nbp/support-matrix/_index.md index db66749e..1bb82c4e 100644 --- a/content/support-matrix/nbp/csi-pnp/_index.md +++ b/content/projects/nbp/support-matrix/_index.md @@ -1,8 +1,8 @@ --- -title: Container Storage Interface(CSI) Plug-N-Play provided by SODA -menuTitle: CSI Plug-N-Play +title: Support Matrix for Container Storage Interface(CSI) Plug-N-Play +menuTitle: support matrix description: "Support Matrix for SODA CSI Plug-N-Play feature" -weight: 10 +weight: 20 disableToc: false tags: ["user guide", "csi", "plug-n-play"] --- diff --git a/content/guides/user-guides/csi/_index.md b/content/projects/nbp/user-guide/_index.md similarity index 88% rename from content/guides/user-guides/csi/_index.md rename to content/projects/nbp/user-guide/_index.md index 1681e677..46e4dbdb 100644 --- a/content/guides/user-guides/csi/_index.md +++ b/content/projects/nbp/user-guide/_index.md @@ -1,6 +1,6 @@ --- -title: NBP -menuTitle: NBP +title: User Guide +menuTitle: user guide description: "All the CSI user guides for different SODA CSI solutions can be found here" weight: 10 disableToc: false diff --git a/content/guides/user-guides/csi/ceph-csi/_index.md b/content/projects/nbp/user-guide/ceph-csi/_index.md similarity index 98% rename from content/guides/user-guides/csi/ceph-csi/_index.md rename to content/projects/nbp/user-guide/ceph-csi/_index.md index cf150552..8c461773 100644 --- a/content/guides/user-guides/csi/ceph-csi/_index.md +++ b/content/projects/nbp/user-guide/ceph-csi/_index.md @@ -20,11 +20,11 @@ Volumes for Pods. over [here](https://docs.sodafoundation.io/soda-gettingstarted/installation-using-ansible/)), you need to change the ports of etcd in osdsdb.yaml while installing SODA on an existing K8s environment as the ports cause conflict with k8s etcd. -- SODA CSI provisioner image to be used based on SODA release version. Refer support matrix over [here](/support-matrix/nbp/csi-pnp/#sidecar-version-support) +- SODA CSI provisioner image to be used based on SODA release version. ## Selecting the vendor CSI driver -You can select the CSI driver supported by SODA Plug-N-Play from [here](https://docs.sodafoundation.io/support-matrix/nbp/csi-pnp/) Once selected follow the instruction +You can select the CSI driver supported by SODA Plug-N-Play from [here](https://docs.sodafoundation.io/projects/nbp/support-matrix/) Once selected follow the instruction given in the document to deploy the CSI driver in K8s. ##### For this example we are selecting the [CEPH-RBD CSI Driver](https://github.com/ceph/ceph-csi). diff --git a/content/guides/developer-guides/_index.md b/content/projects/orchestration/_index.md similarity index 75% rename from content/guides/developer-guides/_index.md rename to content/projects/orchestration/_index.md index 13baed0f..e7381b4d 100644 --- a/content/guides/developer-guides/_index.md +++ b/content/projects/orchestration/_index.md @@ -1,6 +1,6 @@ --- -title: Developer Guides -description: "Start here if you want to know about developing for/with SODA Foundation Projects." +title: Orchestration +description: "Developer guide for orchestration" weight: 30 disableToc: true --- diff --git a/content/guides/developer-guides/orchestration/_index.md b/content/projects/orchestration/developer-guide/_index.md similarity index 99% rename from content/guides/developer-guides/orchestration/_index.md rename to content/projects/orchestration/developer-guide/_index.md index c180631c..b7661220 100644 --- a/content/guides/developer-guides/orchestration/_index.md +++ b/content/projects/orchestration/developer-guide/_index.md @@ -1,11 +1,12 @@ --- -title: Orchestration and Automation +title: Developer guide description: "Developer Guide for Orchestration and Automation" weight: 10 disableToc: false tags: ["developer guide", "orchestration", "automation"] --- ## Overview + This guide is intended for Orchestration and Automation developers. It provides detailed steps to write new workflows for sequence of actions and Orchestrate them through OpenSDS. To undestand the feature and requirements in detail, please refer to the Orchestration user guide and Orchestration design doc. OpenSDS currently uses StackStorm as the Orchestration manager. It uses Mistral workflows of StackStorm. ## Workflows and Actions diff --git a/content/guides/user-guides/orchestration/_index.md b/content/projects/orchestration/user-guide/_index.md similarity index 99% rename from content/guides/user-guides/orchestration/_index.md rename to content/projects/orchestration/user-guide/_index.md index 6818b73c..4ed2b7f7 100644 --- a/content/guides/user-guides/orchestration/_index.md +++ b/content/projects/orchestration/user-guide/_index.md @@ -1,5 +1,5 @@ --- -title: Orchestration +title: User Guide description: "User guide for Orchestration and automation." weight: 10 disableToc: false diff --git a/content/guides/user-guides/orchestration/migration_bucket.PNG b/content/projects/orchestration/user-guide/migration_bucket.PNG similarity index 100% rename from content/guides/user-guides/orchestration/migration_bucket.PNG rename to content/projects/orchestration/user-guide/migration_bucket.PNG diff --git a/content/guides/user-guides/orchestration/orchestration_services.PNG b/content/projects/orchestration/user-guide/orchestration_services.PNG similarity index 100% rename from content/guides/user-guides/orchestration/orchestration_services.PNG rename to content/projects/orchestration/user-guide/orchestration_services.PNG diff --git a/content/guides/user-guides/orchestration/volume_provision.PNG b/content/projects/orchestration/user-guide/volume_provision.PNG similarity index 100% rename from content/guides/user-guides/orchestration/volume_provision.PNG rename to content/projects/orchestration/user-guide/volume_provision.PNG diff --git a/content/projects/strato/_index.md b/content/projects/strato/_index.md new file mode 100644 index 00000000..bd69a40c --- /dev/null +++ b/content/projects/strato/_index.md @@ -0,0 +1,29 @@ +--- +title: SODA Strato +menuTitle: Strato +description: "The guides of features of strato SODA Project" +weight: 1 +disableToc: true +--- + +This section provides Guides for various features from strato of SODA Foundation. Focuses mainly on the usage of the features in these document. If you are interested to develop/port etc, please refer the developer guides or contact us through any of the technical channels. + +### SODA Multicloud(Strato) + +SODA Strato (previously known as the Multi-cloud project) a cloud vendor agnostic data management for hybrid cloud, intercloud, or intracloud. The goal is to provide a unified interface to support file, block,and object services across multiple cloud vendors. It can be hosted on-premise or in the cloud. + +For object data management, it provides a backend manager which is S3 compatible APIs to connect with any cloud vendors. Currently, MS Azure, GCP, AWS, Huawei, IBM, Alibaba backends are supported and getting updated with new backends regularly. + +It also supports Ceph backed to enable on-prem. China Unicom has integrated their YIG project into SODA Multicloud, enabling Ceph to be used as a massively scalable backend object storage. + +SODA multi-cloud also supports creating Storage Service Plans(SSP) for creating tenant based access to multi-cloud storages. + +Basic file service support is added for AWS, Azure, GCP and Huawei and basic block service support is added for AWS EBS and Huawei. + +The technical team is exploring to extend SODA Multicloud and other key layers of SODA into a distributed data store which can support block, file and object data management across the edge, on-premise, and cloud + +[Source Code Repository](https://github.com/sodafoundation/multi-cloud) + +[Support Matrix](https://docs.sodafoundation.io/support-matrix/multi-cloud/) +{{%children style="h3" description="true" %}} + \ No newline at end of file diff --git a/content/projects/strato/developer-guides/_index.md b/content/projects/strato/developer-guides/_index.md new file mode 100644 index 00000000..07a4f9c9 --- /dev/null +++ b/content/projects/strato/developer-guides/_index.md @@ -0,0 +1,11 @@ +--- +title: Strato Developer Guides +menuTitle: Developer Guides +description: "This section will contain developer guides for strato project" +weight: 10 +disableToc: true +--- + +This section provides Developer Guides for various features from strato project of SODA Foundation. If you are interested in just using the features, please refer the user guides or contact us through any of the technical channels. + +{{%children style="h3" description="true" %}} \ No newline at end of file diff --git a/content/guides/developer-guides/multi-cloud/_index.md b/content/projects/strato/developer-guides/installation /_index.md similarity index 97% rename from content/guides/developer-guides/multi-cloud/_index.md rename to content/projects/strato/developer-guides/installation /_index.md index ce8204f5..bc7fe122 100644 --- a/content/guides/developer-guides/multi-cloud/_index.md +++ b/content/projects/strato/developer-guides/installation /_index.md @@ -1,6 +1,7 @@ --- -title: Multi Cloud -description: "User guide for Multi Cloud service." +title: Installation and Testing +menuTitle: Installation +description: "Developer guide for Multi Cloud service(strato)." weight: 10 disableToc: false tags: ["user guide", "multicloud"] diff --git a/content/guides/developer-guides/object-lifecycle-management/_index.md b/content/projects/strato/developer-guides/object-lifecycle-management/_index.md similarity index 100% rename from content/guides/developer-guides/object-lifecycle-management/_index.md rename to content/projects/strato/developer-guides/object-lifecycle-management/_index.md diff --git a/content/guides/developer-guides/object-lifecycle-management/opensds_mongo.PNG b/content/projects/strato/developer-guides/object-lifecycle-management/opensds_mongo.PNG similarity index 100% rename from content/guides/developer-guides/object-lifecycle-management/opensds_mongo.PNG rename to content/projects/strato/developer-guides/object-lifecycle-management/opensds_mongo.PNG diff --git a/content/guides/developer-guides/object-lifecycle-management/opensds_mongo.png b/content/projects/strato/developer-guides/object-lifecycle-management/opensds_mongo.png similarity index 100% rename from content/guides/developer-guides/object-lifecycle-management/opensds_mongo.png rename to content/projects/strato/developer-guides/object-lifecycle-management/opensds_mongo.png diff --git a/content/guides/developer-guides/object-lifecycle-management/postman.png b/content/projects/strato/developer-guides/object-lifecycle-management/postman.png similarity index 100% rename from content/guides/developer-guides/object-lifecycle-management/postman.png rename to content/projects/strato/developer-guides/object-lifecycle-management/postman.png diff --git a/content/support-matrix/multi-cloud/_index.md b/content/projects/strato/support-matrix/_index.md similarity index 95% rename from content/support-matrix/multi-cloud/_index.md rename to content/projects/strato/support-matrix/_index.md index d4c1de1a..ce1f9aae 100644 --- a/content/support-matrix/multi-cloud/_index.md +++ b/content/projects/strato/support-matrix/_index.md @@ -1,8 +1,8 @@ --- -title: Multi-cloud support matrix -menuTitle: Multi-cloud +title: Support Matrix +menuTitle: Support Matrix description: "Matrix data for supported cloud vendors and features" -weight: 15 +weight: 30 disableToc: false tags: ["support matrix", "multi-cloud", "cloud vendors"] --- diff --git a/content/guides/user-guides/multi-cloud/file-and-block/_index.md b/content/projects/strato/user-guides/File-and-block/_index.md similarity index 97% rename from content/guides/user-guides/multi-cloud/file-and-block/_index.md rename to content/projects/strato/user-guides/File-and-block/_index.md index 2382dd07..a39d0a64 100644 --- a/content/guides/user-guides/multi-cloud/file-and-block/_index.md +++ b/content/projects/strato/user-guides/File-and-block/_index.md @@ -28,7 +28,7 @@ To refer the API specs, please check [multi-cloud API specs](https://github.com/ ## Installing SODA multi-cloud Please refer [SODA installation using Ansible](https://docs.sodafoundation.io/soda-gettingstarted/installation-using-ansible/) -Or Check the developer guide [multi-cloud lcoal cluster installation through repo](https://docs.sodafoundation.io/guides/developer-guides/multi-cloud/) +Or Check the developer guide [multi-cloud lcoal cluster installation through repo](https://docs.sodafoundation.io/projects/strato/developer-guides/) ##### SODA Dashboard UI can be accessed via http://{your_host_ip}:8088/#/home @@ -110,8 +110,3 @@ You can choose to modify the File Share attributes The File Share should be deleted > Please note that the volume or file share attributes, metadata and tags are compatible with Cloud vendors. Please refer cloud vendor docs for more details - - - - - diff --git a/content/guides/user-guides/multi-cloud/file-and-block/soda_backend.png b/content/projects/strato/user-guides/File-and-block/soda_backend copy.png similarity index 100% rename from content/guides/user-guides/multi-cloud/file-and-block/soda_backend.png rename to content/projects/strato/user-guides/File-and-block/soda_backend copy.png diff --git a/content/projects/strato/user-guides/File-and-block/soda_backend.png b/content/projects/strato/user-guides/File-and-block/soda_backend.png new file mode 100644 index 00000000..2817b1c7 Binary files /dev/null and b/content/projects/strato/user-guides/File-and-block/soda_backend.png differ diff --git a/content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_block_register.png b/content/projects/strato/user-guides/File-and-block/soda_cloud_block_register.png similarity index 100% rename from content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_block_register.png rename to content/projects/strato/user-guides/File-and-block/soda_cloud_block_register.png diff --git a/content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_fs_list.png b/content/projects/strato/user-guides/File-and-block/soda_cloud_fs_list.png similarity index 100% rename from content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_fs_list.png rename to content/projects/strato/user-guides/File-and-block/soda_cloud_fs_list.png diff --git a/content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_fs_register.png b/content/projects/strato/user-guides/File-and-block/soda_cloud_fs_register.png similarity index 100% rename from content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_fs_register.png rename to content/projects/strato/user-guides/File-and-block/soda_cloud_fs_register.png diff --git a/content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_vol_create.png b/content/projects/strato/user-guides/File-and-block/soda_cloud_vol_create.png similarity index 100% rename from content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_vol_create.png rename to content/projects/strato/user-guides/File-and-block/soda_cloud_vol_create.png diff --git a/content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_volume_list.png b/content/projects/strato/user-guides/File-and-block/soda_cloud_volume_list.png similarity index 100% rename from content/guides/user-guides/multi-cloud/file-and-block/soda_cloud_volume_list.png rename to content/projects/strato/user-guides/File-and-block/soda_cloud_volume_list.png diff --git a/content/guides/user-guides/multi-cloud/file-and-block/soda_create_fs.png b/content/projects/strato/user-guides/File-and-block/soda_create_fs.png similarity index 100% rename from content/guides/user-guides/multi-cloud/file-and-block/soda_create_fs.png rename to content/projects/strato/user-guides/File-and-block/soda_create_fs.png diff --git a/content/guides/user-guides/multi-cloud/file-and-block/soda_home.png b/content/projects/strato/user-guides/File-and-block/soda_home.png similarity index 100% rename from content/guides/user-guides/multi-cloud/file-and-block/soda_home.png rename to content/projects/strato/user-guides/File-and-block/soda_home.png diff --git a/content/guides/user-guides/multi-cloud/_index.md b/content/projects/strato/user-guides/_index.md similarity index 79% rename from content/guides/user-guides/multi-cloud/_index.md rename to content/projects/strato/user-guides/_index.md index 23a9d1f0..9ce3064c 100644 --- a/content/guides/user-guides/multi-cloud/_index.md +++ b/content/projects/strato/user-guides/_index.md @@ -1,6 +1,6 @@ --- -title: Multi-cloud -description: "The user guides for SODA multi-cloud Project features" +title: User Guides +description: "The user guides for SODA multi-cloud(strato) Project features" weight: 20 disableToc: true --- diff --git a/content/guides/user-guides/multi-cloud/aksk/ak-sk-using-api.md b/content/projects/strato/user-guides/aksk/aksk-using-api.md similarity index 99% rename from content/guides/user-guides/multi-cloud/aksk/ak-sk-using-api.md rename to content/projects/strato/user-guides/aksk/aksk-using-api.md index 1729aad2..247569e3 100644 --- a/content/guides/user-guides/multi-cloud/aksk/ak-sk-using-api.md +++ b/content/projects/strato/user-guides/aksk/aksk-using-api.md @@ -160,4 +160,4 @@ To get the AK/SK of a particular user, execute the GET API of AK/SK using the cU ``` - More details about the Keystone Credential APIs can be found [here](https://docs.openstack.org/api-ref/identity/v3/index.html?expanded=create-credential-detail,delete-credential-detail,update-credential-detail#credentials). \ No newline at end of file + More details about the Keystone Credential APIs can be found [here](https://docs.openstack.org/api-ref/identity/v3/index.html?expanded=create-credential-detail,delete-credential-detail,update-credential-detail#credentials). diff --git a/content/guides/user-guides/multi-cloud/object-archival-restore/_index.md b/content/projects/strato/user-guides/object-archival-restore/_index.md similarity index 96% rename from content/guides/user-guides/multi-cloud/object-archival-restore/_index.md rename to content/projects/strato/user-guides/object-archival-restore/_index.md index 6fc09b39..501ac1eb 100644 --- a/content/guides/user-guides/multi-cloud/object-archival-restore/_index.md +++ b/content/projects/strato/user-guides/object-archival-restore/_index.md @@ -24,7 +24,7 @@ To refer the API specs, please check [Cloud Object Archival API Specs](https://g ## Installing SODA multi-cloud Please refer [SODA installation using Ansible](https://docs.sodafoundation.io/soda-gettingstarted/installation-using-ansible/) -Or Check the developer guide [multi-cloud local cluster installation through repo](https://docs.sodafoundation.io/guides/developer-guides/multi-cloud/) +Or Check the developer guide [multi-cloud local cluster installation through repo](https://docs.sodafoundation.io/projects/strato/developer-guides/) ##### SODA Dashboard UI can be accessed via http://{your_host_ip}:8088/#/home @@ -80,5 +80,4 @@ Once the restoration of object is inititated, it may take time for the availabil ## Download of archived object Once the restoration of object is complete, the object can be downloaded by clicking on the **Download** Operation - ![multi-cloud archived object download](soda_archived_object_download.png?raw=true) - + ![multi-cloud archived object download](soda_archived_object_download.png?raw=true) diff --git a/content/guides/user-guides/multi-cloud/object-archival-restore/soda_archived_object_download.png b/content/projects/strato/user-guides/object-archival-restore/soda_archived_object_download.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-archival-restore/soda_archived_object_download.png rename to content/projects/strato/user-guides/object-archival-restore/soda_archived_object_download.png diff --git a/content/guides/user-guides/multi-cloud/object-archival-restore/soda_archived_object_list.png b/content/projects/strato/user-guides/object-archival-restore/soda_archived_object_list.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-archival-restore/soda_archived_object_list.png rename to content/projects/strato/user-guides/object-archival-restore/soda_archived_object_list.png diff --git a/content/guides/user-guides/multi-cloud/object-archival-restore/soda_backend.png b/content/projects/strato/user-guides/object-archival-restore/soda_backend.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-archival-restore/soda_backend.png rename to content/projects/strato/user-guides/object-archival-restore/soda_backend.png diff --git a/content/guides/user-guides/multi-cloud/object-archival-restore/soda_bucket.png b/content/projects/strato/user-guides/object-archival-restore/soda_bucket.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-archival-restore/soda_bucket.png rename to content/projects/strato/user-guides/object-archival-restore/soda_bucket.png diff --git a/content/guides/user-guides/multi-cloud/object-archival-restore/soda_home.png b/content/projects/strato/user-guides/object-archival-restore/soda_home.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-archival-restore/soda_home.png rename to content/projects/strato/user-guides/object-archival-restore/soda_home.png diff --git a/content/guides/user-guides/multi-cloud/object-archival-restore/soda_object_archival.png b/content/projects/strato/user-guides/object-archival-restore/soda_object_archival.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-archival-restore/soda_object_archival.png rename to content/projects/strato/user-guides/object-archival-restore/soda_object_archival.png diff --git a/content/guides/user-guides/multi-cloud/object-archival-restore/soda_object_restore.png b/content/projects/strato/user-guides/object-archival-restore/soda_object_restore.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-archival-restore/soda_object_restore.png rename to content/projects/strato/user-guides/object-archival-restore/soda_object_restore.png diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/_index.md b/content/projects/strato/user-guides/object-lifecycle-management/_index.md similarity index 99% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/_index.md rename to content/projects/strato/user-guides/object-lifecycle-management/_index.md index 74548263..637cdf03 100644 --- a/content/guides/user-guides/multi-cloud/object-lifecycle-management/_index.md +++ b/content/projects/strato/user-guides/object-lifecycle-management/_index.md @@ -29,15 +29,18 @@ git checkout master Install docker container to run multi-cloud in container environment. Update the file : opensds-installer/ansible/group_vars/gelato.yml to install multi-cloud. + ```cassandraql # repository branch gelato_repo_branch: master ``` + Detailed instruction is in this link - [SODA Local Cluster Installation through Ansible On Ubuntu](https://github.com/opensds/opensds/wiki/OpenSDS-Cluster-Installation-through-Ansible) (Recommended) #### Export required SODA environment variables + ``` export HOST_IP={your_real_host_ip} export OPENSDS_ENDPOINT=http://{{ apiserver_cluster_ip }}:50040 diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_backend.PNG b/content/projects/strato/user-guides/object-lifecycle-management/opensds_backend.PNG similarity index 100% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_backend.PNG rename to content/projects/strato/user-guides/object-lifecycle-management/opensds_backend.PNG diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_bucket.PNG b/content/projects/strato/user-guides/object-lifecycle-management/opensds_bucket.PNG similarity index 100% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_bucket.PNG rename to content/projects/strato/user-guides/object-lifecycle-management/opensds_bucket.PNG diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_home.PNG b/content/projects/strato/user-guides/object-lifecycle-management/opensds_home.PNG similarity index 100% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_home.PNG rename to content/projects/strato/user-guides/object-lifecycle-management/opensds_home.PNG diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_lifecycle.PNG b/content/projects/strato/user-guides/object-lifecycle-management/opensds_lifecycle.PNG similarity index 100% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_lifecycle.PNG rename to content/projects/strato/user-guides/object-lifecycle-management/opensds_lifecycle.PNG diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_lifecycle_config.PNG b/content/projects/strato/user-guides/object-lifecycle-management/opensds_lifecycle_config.PNG similarity index 100% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_lifecycle_config.PNG rename to content/projects/strato/user-guides/object-lifecycle-management/opensds_lifecycle_config.PNG diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_object.PNG b/content/projects/strato/user-guides/object-lifecycle-management/opensds_object.PNG similarity index 100% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/opensds_object.PNG rename to content/projects/strato/user-guides/object-lifecycle-management/opensds_object.PNG diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/register-backend-0.png b/content/projects/strato/user-guides/object-lifecycle-management/register-backend-0.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/register-backend-0.png rename to content/projects/strato/user-guides/object-lifecycle-management/register-backend-0.png diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/register-backend.png b/content/projects/strato/user-guides/object-lifecycle-management/register-backend.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/register-backend.png rename to content/projects/strato/user-guides/object-lifecycle-management/register-backend.png diff --git a/content/guides/user-guides/multi-cloud/object-lifecycle-management/soda_login_page.png b/content/projects/strato/user-guides/object-lifecycle-management/soda_login_page.png similarity index 100% rename from content/guides/user-guides/multi-cloud/object-lifecycle-management/soda_login_page.png rename to content/projects/strato/user-guides/object-lifecycle-management/soda_login_page.png diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/SSP.png b/content/projects/strato/user-guides/storage-service-plan/SSP.png similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/SSP.png rename to content/projects/strato/user-guides/storage-service-plan/SSP.png diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/SSP_Archive.png b/content/projects/strato/user-guides/storage-service-plan/SSP_Archive.png similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/SSP_Archive.png rename to content/projects/strato/user-guides/storage-service-plan/SSP_Archive.png diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/SSP_Create.png b/content/projects/strato/user-guides/storage-service-plan/SSP_Create.png similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/SSP_Create.png rename to content/projects/strato/user-guides/storage-service-plan/SSP_Create.png diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/SSP_CreateBucket.png b/content/projects/strato/user-guides/storage-service-plan/SSP_CreateBucket.png similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/SSP_CreateBucket.png rename to content/projects/strato/user-guides/storage-service-plan/SSP_CreateBucket.png diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/SSP_Restore.png b/content/projects/strato/user-guides/storage-service-plan/SSP_Restore.png similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/SSP_Restore.png rename to content/projects/strato/user-guides/storage-service-plan/SSP_Restore.png diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/SSP_Upload.png b/content/projects/strato/user-guides/storage-service-plan/SSP_Upload.png similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/SSP_Upload.png rename to content/projects/strato/user-guides/storage-service-plan/SSP_Upload.png diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/_index.md b/content/projects/strato/user-guides/storage-service-plan/_index.md similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/_index.md rename to content/projects/strato/user-guides/storage-service-plan/_index.md diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/register-backend-0.png b/content/projects/strato/user-guides/storage-service-plan/register-backend-0.png similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/register-backend-0.png rename to content/projects/strato/user-guides/storage-service-plan/register-backend-0.png diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/registerBackend.png b/content/projects/strato/user-guides/storage-service-plan/registerBackend.png similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/registerBackend.png rename to content/projects/strato/user-guides/storage-service-plan/registerBackend.png diff --git a/content/guides/user-guides/multi-cloud/storage-service-plan/soda_login_page.png b/content/projects/strato/user-guides/storage-service-plan/soda_login_page.png similarity index 100% rename from content/guides/user-guides/multi-cloud/storage-service-plan/soda_login_page.png rename to content/projects/strato/user-guides/storage-service-plan/soda_login_page.png diff --git a/content/projects/terra/_index.md b/content/projects/terra/_index.md new file mode 100644 index 00000000..78481e98 --- /dev/null +++ b/content/projects/terra/_index.md @@ -0,0 +1,42 @@ +--- +title: Terra +description: "This page provides the details of SODA DashBoard" +weight: 3 +disableToc: false +--- + +- ### SODA API + + The SODA API, Provides the standardization for Data / Storage Management APIs. At present, block and file APIs for key features of data management (provisioning, migration, fileshare, etc) are supported. + + This is the key external interface to platforms which can do a seamless integration with heterogeneous storage backends. + + Users can develop SODA North-Bound Plugins (SODA NBP) under SODA NBP project to connect any platform or application solutions to SODA API from north for all storage/data requirements. + + This is envisioned to be the reference implementation of SODA Data Standard API Specification, with contributions from industry partners and standards bodies. At that stage, this layer will upgraded to support Block, File and Object APIs across the Edge, Core and Cloud. + + [Source Code Repository](https://github.com/sodafoundation/api) + +- ### SODA Controller + + The SODA Controller, provides metadata management, control/configurations, scheduler and all such book-keeping features and utilities. In the API flow from SODA API to SODA Dock, controller plays a critical role for all the API flow management and tracking to handle all the state machine and metadata management requirements. This is a layer to keep addons to new facilities or utilities for the SODA platform. + + At present, this layer can be optional or similar modules can be used from users(if they have such software components). However, users need to integrate the Controller modules with SODA API and SODA Dock. + + The Controller interfaces with SODA API and SODA Dock. + + [Source Code Repository](https://github.com/sodafoundation/controller) + +- ### SODA Dock + + SODA Dock is a docking station for heterogeneous storage backends! This is where all the different storage vendors drivers for various storage backend models get attached. + + The goal is to make most of the protocols and backends supported as close as ‘plug n play’. Currently, each storage backend needs a thin, easy to develop SODA Driver Plugin to connect the storage backend to the Dock. SODA Driver Plugin and Storage vendor driver together it can be called SODA Driver for xxx vendor yy model storage.SODA Driver can support one or more or multiple classes of storage backends. + + To connect more and more cloud-native storages seamlessly with the SODA Platform,there is an experimental feature for CSI PlugNPlay is developed. This will immediately enable any CSI driver to work with SODA using a single SODA CSI plugin for the application platform (like Kubernetes), in turn, support all the storage vendors supporting CSI. + + SODA Dock can interface directly to SODA API or via Controller. However, it is recommended through the controller for a complete end to end solution, as it can provide the metadata management, handling multiple docks, etc. + + The roadmap is to have multiple instances, multi-driver docks to support multi-cluster, multi-platform, or multi-cloud scenarios in the future. + + [Source Code Repository](https://github.com/sodafoundation/dock) diff --git a/content/guides/developer-guides/file-share/_index.md b/content/projects/terra/developer-guide/_index.md similarity index 98% rename from content/guides/developer-guides/file-share/_index.md rename to content/projects/terra/developer-guide/_index.md index 2fab697f..56555059 100644 --- a/content/guides/developer-guides/file-share/_index.md +++ b/content/projects/terra/developer-guide/_index.md @@ -1,6 +1,6 @@ --- -title: File Share -description: "Installation & Developer Guide for File Share" +title: Developer Guide for file share +description: "Developer Guide for File Share" weight: 10 disableToc: false tags: ["developer guide", "file share"] diff --git a/content/guides/user-guides/file-share/_index.md b/content/projects/terra/user-guide/_index.md similarity index 99% rename from content/guides/user-guides/file-share/_index.md rename to content/projects/terra/user-guide/_index.md index fc691222..9394ccb5 100644 --- a/content/guides/user-guides/file-share/_index.md +++ b/content/projects/terra/user-guide/_index.md @@ -1,7 +1,7 @@ --- -title: File Share +title: User Guide for File Share description: "User guide for File Share feature." -weight: 10 +weight: 20 disableToc: false tags: ["user guide", "file share"] --- diff --git a/content/guides/user-guides/file-share/fileshare_menu.PNG b/content/projects/terra/user-guide/fileshare_menu.PNG similarity index 100% rename from content/guides/user-guides/file-share/fileshare_menu.PNG rename to content/projects/terra/user-guide/fileshare_menu.PNG diff --git a/content/guides/user-guides/file-share/snapshot_access.PNG b/content/projects/terra/user-guide/snapshot_access.PNG similarity index 100% rename from content/guides/user-guides/file-share/snapshot_access.PNG rename to content/projects/terra/user-guide/snapshot_access.PNG diff --git a/content/releases/_index.md b/content/releases/_index.md index e0bc07b8..839aa6ce 100644 --- a/content/releases/_index.md +++ b/content/releases/_index.md @@ -1,7 +1,7 @@ --- title: Releases and Roadmaps description: "SODA Releases and Roadmap" -weight: 8 +weight: 10 disableToc: false --- ## Releases diff --git a/content/soda-cdm/_index.md b/content/soda-cdm/_index.md index 46b30d52..a7cdf019 100644 --- a/content/soda-cdm/_index.md +++ b/content/soda-cdm/_index.md @@ -2,10 +2,10 @@ title: SODA Container Data Management menuTitle: SODA CDM description: "All the guides and detailed documentation for SODA Container Data Management Projects" -weight: 7 +weight: 8 disableToc: false --- This section provides different guides and documentations, like user guides, developer guides, integration guides, tutorials and more for the various SODA Container Data Management projects. -{{%children style="h3" description="true" %}} \ No newline at end of file +{{%children style="h3" description="true" %}} \ No newline at end of file diff --git a/content/soda-cdm/kahu/_index.md b/content/soda-cdm/kahu/_index.md index 5476eedc..465dc90d 100644 --- a/content/soda-cdm/kahu/_index.md +++ b/content/soda-cdm/kahu/_index.md @@ -2,10 +2,11 @@ title: Kahu - The SODA container data backup and restore project menuTitle: Kahu description: "All the guides and detailed documentation for Kahu Project" -weight: 7 +weight: 1 disableToc: false --- This section provides different guides and documentations, like user guides, developer guides, integration guides, tutorials and more for Kahu - The SODA container data backup and restore project. -{{%children style="h3" description="true" %}} \ No newline at end of file +{{%children style="h3" description="true" %}} + \ No newline at end of file diff --git a/content/soda-gettingstarted/_index.md b/content/soda-gettingstarted/_index.md index f8e26f96..4b25110f 100644 --- a/content/soda-gettingstarted/_index.md +++ b/content/soda-gettingstarted/_index.md @@ -6,13 +6,15 @@ disableToc: false --- ## SODA Installation Guides + SODA Projects can be installed in different ways. To quickly install using release binaries without much of configuration controls, use the [Quick Start Guide](https://docs.sodafoundation.io/soda-gettingstarted/quickstart/). It lists the steps to install directly from a specific release binaries. -To configure according to a solution requirement and to have more control on the projects, use the Installation Guide (https://docs.sodafoundation.io/soda-gettingstarted/installation/) . +To configure according to a solution requirement and to have more control on the projects, use the Installation Guide [here](https://docs.sodafoundation.io/soda-gettingstarted/installation/). + +#### 1. [Quick Start Guide](https://docs.sodafoundation.io/soda-gettingstarted/quickstart/) -### [Quick Start Guide](https://docs.sodafoundation.io/soda-gettingstarted/quickstart/) This is a quickstart guide for users and new contributors to get the first and quick experience of SODA Release. +#### 2. [Installation Guide](https://docs.sodafoundation.io/soda-gettingstarted/installation/) -### [Installation Guide](https://docs.sodafoundation.io/soda-gettingstarted/installation/) This guide explains how to configure and install the SODA Foundation Projects with its components. You will have more configuration options and control over the installation. diff --git a/content/support-matrix/_index.md b/content/support-matrix/_index.md deleted file mode 100644 index f1a31e40..00000000 --- a/content/support-matrix/_index.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -title: Support Matrix -description: "Support matrix data for SODA can be found here" -weight: 5 -disableToc: false ---- - -This section provides information about the support matrix data for SODA. - - -{{%children style="h3" description="true" %}} \ No newline at end of file diff --git a/go.sum b/go.sum index e69de29b..8b137891 100644 --- a/go.sum +++ b/go.sum @@ -0,0 +1 @@ + diff --git a/install_local.sh b/install_local.sh index 5671b350..a3386dd4 100755 --- a/install_local.sh +++ b/install_local.sh @@ -24,19 +24,19 @@ then elif [ $? = '1' ] then printf "Hugo is not installed \n" - printf "Downloading hugo_0.55.6_Linux-64bit.deb ... \n" - curl --progress-bar --remote-name --location https://github.com/gohugoio/hugo/releases/download/v0.55.6/hugo_0.55.6_Linux-64bit.deb + printf "Downloading hugo_0.92.2_Linux-64bit.deb ... \n" + curl --progress-bar --remote-name --location https://github.com/gohugoio/hugo/releases/download/v0.92.2/hugo_0.92.2_Linux-64bit.deb printf "Download complete. \n" printf "Unpacking... \n" - sudo dpkg -i hugo_0.55.6_Linux-64bit.deb &> /dev/null + sudo dpkg -i hugo_0.92.2_Linux-64bit.deb &> /dev/null printf "Unpacking complete. \n" printf "Installing Hugo... \n" sudo apt-get install -f &> /dev/null printf "Installation complete. \n" hugo version printf "Cleaning up...\n" - printf "Deleting hugo_0.55.6_Linux-64bit.deb ... \n" - rm hugo_0.55.6_Linux-64bit.deb* + printf "Deleting hugo_0.92.2_Linux-64bit.deb ... \n" + rm hugo_0.92.2_Linux-64bit.deb* printf "Clean up complete. \n" printf "\n\n" fi