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

Introduction and Explanation for the IaaS Layer #101

Open
6 tasks
maxwolfs opened this issue Nov 6, 2023 · 0 comments
Open
6 tasks

Introduction and Explanation for the IaaS Layer #101

maxwolfs opened this issue Nov 6, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation IaaS Issues or pull requests relevant for Team1: IaaS

Comments

@maxwolfs
Copy link
Member

maxwolfs commented Nov 6, 2023

As the Sovereign Cloud Stack (SCS) continues to evolve, there is an increasing need for clear and comprehensive documentation, especially for its Infrastructure as a Service (IaaS) layer. The documentation should serve as resource for new users and contributors, helping them understand the architecture and functionalities of the IaaS layer within the SCS ecosystem and interplay of OSISM. The goal is to create an overview section as seen in the standard SCS-002-v2

├── IaaS Layer
│    ├── Overview
│    │        ├── Architecture
│    │        ├── Compute
│    │        ├── Storage
│    │        ├── Network
│    │        ├── Control
│    │        └── Knowledge
...

within the existing SCS documentation that accomplishes the following:

  1. Provides a detailed introduction to the IaaS layer, explaining its role, benefits, and the problems it solves within the SCS framework. Important: Distinguish two different intros for operators coming from either "OpenStack" or "Virtual Machine Orchestration (VMWare, HyperV, ProxMox – Starting from Scratch)". Compare the already existing Container Layer introduction: https://docs.scs.community/docs/container/
  2. Offers a visual representation of the IaaS layer’s architecture to enhance user comprehension.
  3. Lists the prerequisites for using the IaaS layer, including necessary hardware, software, and technical knowledge for from either "OpenStack" or "Virtual Machine Orchestration (VMWare, HyperV, ProxMox – Starting from Scratch)".
  4. Presents a "Quickstart" guide for new users to get a basic setup running, with step-by-step instructions suitable for testing environments. See section of "Deployment Examples".
  5. Explains how to configure the IaaS layer, detailing the various options, parameters, and settings available.
  6. Guides users on how to contribute to the IaaS layer's development, including issue submission and participation in discussions.

Action Items:

  • Draft an introductory document for the IaaS layer.
  • Develop a comprehensive visual diagram of the IaaS layer's architecture.
  • Compile a list of prerequisites for the IaaS layer setup.
  • Create a "Quickstart" guide for the IaaS layer.
  • Detail the configuration options available for the IaaS layer.
  • Prepare a contribution guide for the IaaS layer.

As a lof of this is covered within the OSISM documentation it is important to distinguish which content should be written from the SCS perspective and what can be implemented via copying content from the OSISM Docs via the docs sync workflow such as the Guides.

The introduction should be aligned with the SCS Documentation structure, reflecting the logical hierarchy and aiding users in navigating the complex SCS ecosystem.

By accomplishing this, we aim to foster a transparent, inclusive community environment and facilitate the onboarding process for new users and contributors to the SCS.

See also: SovereignCloudStack/issues#124

@maxwolfs maxwolfs added documentation Improvements or additions to documentation IaaS Issues or pull requests relevant for Team1: IaaS labels Nov 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation IaaS Issues or pull requests relevant for Team1: IaaS
Projects
None yet
Development

No branches or pull requests

2 participants