OSC Requests For Comments

This repository serves as a discussion platform for all members of the OSC project. It is a space to share, store, review, approve, and archive ideas, guidelines, general knowledge, and architectural decisions for installing, running, or using the Open Sovereign Cloud.

The goal is to promote collaboration and communication across the entire team. This repository aims to provide transparent, traceable, and version-controlled documentation of decisions on any questions arising from the platform's use.

The content of this repository does not replace per-repository documentation, but covers broader, over-reaching topics, how all the people, hardware and software works together.

Security and confidentiality

No secrets (passwords, private keys, etc.) should be posted in issues, merge requests, review comments, or within the content of the RFC document.

This repository is hosted on DevOps GitLab, which offers access to all internal T-Systems and DTAG employees, as well as external contributors. Members of the OSC project should be able to read and contribute. However, these documents should not be shared with third parties, either in whole or in part, unless approved by product owners and managers.

Repository structure

├── README.md
├── assets/
|   ├──
|   ├──
│   └──
├── rfc/
│   ├── name-one/
│   ├── other-name/
│   └── some-feature/
├── templates/
│   ├── architectural-decision/
│   ├── new-guide/
│   └── reference-process/

README.md is this document, outlining the process and guidelines for using this repo.

assets/ contains files to be referenced from other locations (e.g. images ...).

rfc/ contains list of existing RFC's. The RFC's are not in any particular order, but are given a verbose, easy to remember name, where the words are separated by dash.

templates/ contains examples for documents to be merged in rfc/.

Document structure, types, naming, life-cycle

For the begining, no specific document types are defined. Guide, Reference, Decision, Tutorial or even lessons learned from root-cause analysis will be accepted.

Each document should be placed in its own directory. The document must be written in Markdown or reStructuredText. Each directory thus must include file README.md or README.rst. The directory can include own assets, and may link to and reference other existing documents or their assets.

There is only one template defined for minimalistic RFC document. Feel free to contribute.

The document life-cycle is indicated in the Status: field of the README-file, and it can contain one of the following values:

• draft: indicates the document is in a work-in-progress state.
• approved: indicates document has been reviewed and accepted as current standard.
• deprecated: indicates that document content is no longer valid.

Documents in draft status should not be merged to main.

Contribution Guidelines

The first step is creating an issue in this project. Issues should not just facilitate discussion, but should be closed by contributing with a new document or updating existing document with new content using merge request.

Contributions of new documents should follow the following procedure:

• Identify the need for a new document, either a knowledge sharing document (guide, tutorial, or reference) or an RFC.
• Fork the repository and create a new branch in the form draft-your-doc-name for your contribution.
• Copy the template into rfc/your-doc-name and update with your content.
• Ensure that the content is accurate, clear, and concise. Include examples, diagrams, or illustrations when possible.
• Let the document be reviewed by pushing to this repository and creating a merge-request. If there are comments, you must resolve them by subsequent comits. The last comit should change Status: field to approved, what is followed by formal approval by architecture team and merging to main.