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

EPIC: Documentation of v2 controllers for first SAP internal users #370

Open
2 tasks
morri-son opened this issue Jan 15, 2025 · 0 comments
Open
2 tasks
Assignees
Labels
area/ipcei Important Project of Common European Interest kind/epic Large multi-story topic
Milestone

Comments

@morri-son
Copy link
Contributor

morri-son commented Jan 15, 2025

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
  • Flow diagrams for controllers
  • 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. open-component-model/ocm#1105), 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

@morri-son morri-son added area/ipcei Important Project of Common European Interest kind/epic Large multi-story topic labels Jan 15, 2025
@morri-son morri-son added this to the 2025-Q1 milestone Jan 15, 2025
@morri-son morri-son changed the title EPIC: Documentation of v2 controllers for internal usage EPIC: Documentation of v2 controllers for first SAP internal users Jan 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/ipcei Important Project of Common European Interest kind/epic Large multi-story topic
Projects
Status: 🆕 ToDo
Development

No branches or pull requests

3 participants