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

Proposal to Enhance SCS Documentation with a Detailed Deployment Tutorial #181

Open
maxwolfs opened this issue Apr 19, 2024 · 1 comment · May be fixed by #188
Open

Proposal to Enhance SCS Documentation with a Detailed Deployment Tutorial #181

maxwolfs opened this issue Apr 19, 2024 · 1 comment · May be fixed by #188
Assignees
Labels
documentation Improvements or additions to documentation IaaS Issues or pull requests relevant for Team1: IaaS

Comments

@maxwolfs
Copy link
Contributor

Proposal to Enhance SCS Documentation with a Detailed Deployment Tutorial

Introduction

We propose to enrich the Sovereign Cloud Stack (SCS) documentation by adding a detailed deployment tutorial based on a real-world use case based on Artcodix deployment. This tutorial will illustrate one of many potential solutions for deploying SCS, emphasizing that it does not prescribe the only approach but showcases a viable path that has been effective in our experience.

Objective

The primary goal of this contribution is to make the extensive capabilities of SCS more accessible to new users and to facilitate a deeper understanding of its deployment mechanisms. By providing a step-by-step guide, we intend to help users not only learn the operational aspects of SCS but also encourage them to experiment and adapt the process according to their unique requirements.

This addition is intended as a tutorial, rather than a quick how-to guide, following the diataxis framework (https://diataxis.fr/tutorials-how-to/#understanding-the-distinction). It is designed to offer a comprehensive learning experience, guiding users from the basics to a complete setup, thereby enabling enabling them to understand relevant considerations appropriate for similar sized setups and apply the learning to initiate their own deployments.

@maxwolfs maxwolfs added documentation Improvements or additions to documentation IaaS Issues or pull requests relevant for Team1: IaaS labels Apr 19, 2024
@maxwolfs maxwolfs changed the title Enhance Documentation with Comprehensive Step-by-Step Guide for Real-World Bare Metal SCS Deployment Proposal to Enhance SCS Documentation with a Detailed Deployment Tutorial Apr 19, 2024
@berendt
Copy link
Member

berendt commented Apr 19, 2024

It would be important to go into detail into the steps that need to be taken to prepare a deployment (cookiecutter, configuration repository, network configuration, Ceph configuration, TLS certificates, ...). So that we don't just have the pure deployment process, but also how to get there in order to be able to make a deployment.

@maxwolfs maxwolfs linked a pull request May 6, 2024 that will close this issue
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

Successfully merging a pull request may close this issue.

3 participants