EPIC: Documentation of v2 controllers (Repository documentation)

[morri-son]

Goal

As a DevOps or engineer working at SAP,
I want documentation on how to install and work with the v2 of the OCM controllers,
so that I'm able to understand the basic parts of the setup I need to install in my cluster and how to configure and deploy my service modelled as an OCM component using the OCM controllers.

Scope

In Scope

• Document describing the basic architecture of the OCM controllers (very basic and similar to this doc for the v1 controllers)
• Document describing an end-2-end deployment scenario
  • How to install the OCM controllers
  • How to deploy a service using Helm
  • How to deploy a service using kustomize

Out of Scope

• Extensive explanations of architecture
• Modelling OCM components

User Stories

List the main user stories that make up this epic. Just mention the number of the related user stories here (if in another repo add org and repo as prefix, e.g. #662), it will appear as clickable link later.

Acceptance Criteria

List the high-level conditions that must be met for this epic to be considered complete

• Document describing the basic architecture of the OCM controllers has been created in the ocm-k8s-toolkit repo
• Document describing an end-2-end deployment scenario with installation and two deployment flavours has been created

Additional Links and Notes

• Architecture document of v1 controllers: https://github.com/open-component-model/ocm-controller/blob/main/docs/architecture.md