Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Updated Structure of Docs #309

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 9 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Empty file added .hugo_build.lock
Empty file.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
3 changes: 1 addition & 2 deletions content/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}}
2 changes: 1 addition & 1 deletion content/api-specs/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: SODA API Specification
description: "Provides SODA API Standards for Data and Storage"
weight: 3
weight: 5
disableToc: false
---

Expand Down
2 changes: 1 addition & 1 deletion content/architecture/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: SODA Architecture
description: ""
weight: 3
weight: 4
disableToc: false
---

Expand Down
2 changes: 1 addition & 1 deletion content/community/_index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion content/feedback/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Feedback
description: "Feedback or Suggestions"
weight: 10
weight: 12
disableToc: false
---
## General Feedback
Expand Down
2 changes: 1 addition & 1 deletion content/governance/_index.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
4 changes: 2 additions & 2 deletions content/guides/_index.md
Original file line number Diff line number Diff line change
@@ -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"%}}
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
58 changes: 14 additions & 44 deletions content/projects/_index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
title: SODA Projects
title: SODA FrameWork Projects
wasup-yash marked this conversation as resolved.
Show resolved Hide resolved
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 Project Architecutre Diagram -->
![SODA Projects Architecture](soda-project-architecture.png)

- ### SODA Dashboard
- ### 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.
Expand All @@ -19,55 +20,24 @@ disableToc: false
[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.

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)
[Support Matrix](https://docs.sodafoundation.io/support-matrix/delfin/)

- ### 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/)
Expand All @@ -76,7 +46,8 @@ disableToc: false

[Support Matrix](https://docs.sodafoundation.io/support-matrix/nbp/)

- ### SODA Multicloud
- ### SODA Multicloud(Strato)

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.
Expand All @@ -87,11 +58,10 @@ disableToc: false

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
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/)

- 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)
10 changes: 10 additions & 0 deletions content/projects/dashboard/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: 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.

{{%children style="h3" description="true" %}}
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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/#/)
12 changes: 12 additions & 0 deletions content/projects/delfin/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: 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.

{{%children style="h3" description="true" %}}

Original file line number Diff line number Diff line change
Expand Up @@ -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.


Original file line number Diff line number Diff line change
@@ -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
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" %}}
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,7 @@ Register storage (fake storage for test)


```

Sync alerts

```bash
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Delfin
menuTitle: Delfin
title: Support Matrix
menuTitle: Support Matrix
description: "Support matrix data for drivers of Delfin project"
weight: 10
disableToc: false
Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Delfin
menuTitle: Delfin
title: User Guide
menuTitle: User Guide
description: "All user guides for the Delfin project can be found here"
weight: 10
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" %}}
{{%children style="h3" description="true" %}}
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 |
Expand All @@ -65,8 +64,6 @@ Important configurations that users want change may be,
| | alert_manager_port | '9093' | Alert Manager PORT |
| | | | |



#### Example config file

``` ini
Expand Down Expand Up @@ -100,7 +97,6 @@ alert_manager_host = '<Delfin_IP>'
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)
Expand Down Expand Up @@ -306,4 +302,4 @@ A Sample exporter implementation is provided in Delfin repo for reference. Also,
- [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/)
- [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)
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -366,4 +367,3 @@ This Alertmanager link in the sidebar menu launches the Alertmanager UI.




11 changes: 11 additions & 0 deletions content/projects/strato/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
title: 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.

{{%children style="h3" description="true" %}}

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Multi Cloud
description: "User guide for Multi Cloud service."
title: Developer Guide
description: "Developer guide for Multi Cloud service(strato)."
weight: 10
disableToc: false
tags: ["user guide", "multicloud"]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
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
disableToc: false
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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





Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Multi-cloud
description: "The user guides for SODA multi-cloud Project features"
title: User Guide
description: "The user guides for SODA multi-cloud(strato) Project features"
weight: 20
disableToc: true
---
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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).
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).
Loading