generated from openmcp-project/repository-template
-
Notifications
You must be signed in to change notification settings - Fork 0
docs(user): add first draft guide for getting started #16
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
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,113 @@ | ||
| # Getting Started | ||
|
|
||
| > This is a quick guide on how to get started with the openMCP platform. This guide is not complete and will be extended in the future. | ||
| ## Setup | ||
|
|
||
| ### 1. Create a `Project` | ||
| A `Project` is the starting point to our Manged Control Plane (MCP) journey. It is a logical grouping of `Workspaces` and `ManagedControlPlanes`. A `Project` can be used to represent an organization, department, team or any other logical grouping of resources. | ||
| ```yaml | ||
| apiVersion: core.openmcp.cloud/v1alpha1 | ||
| kind: Project | ||
| metadata: | ||
| name: platform-team | ||
| annotations: | ||
| openmcp.cloud/display-name: Platform Team | ||
| spec: | ||
| members: | ||
| - kind: User | ||
| name: [email protected] | ||
| roles: | ||
| - admin | ||
| - kind: User | ||
| name: [email protected] | ||
| roles: | ||
| - view | ||
| ``` | ||
| ### 2. Create a `Workspace` in the `Project` | ||
|
|
||
| A `Workspace` is a logical grouping of `ManagedControlPlanes`. A `Workspace` can be used to represent an environment (e.g. dev, staging, prod) or again an organization, department, team or any other logical grouping of resources. | ||
|
|
||
| ```yaml | ||
| apiVersion: core.openmcp.cloud/v1alpha1 | ||
| kind: Workspace | ||
| metadata: | ||
| name: dev | ||
| namespace: project-platform-team | ||
| annotations: | ||
| openmcp.cloud/display-name: Platform Team - Dev | ||
| spec: | ||
| members: | ||
| - kind: User | ||
| name: [email protected] | ||
| roles: | ||
| - admin | ||
| - kind: User | ||
| name: [email protected] | ||
| roles: | ||
| - view | ||
| ``` | ||
|
|
||
| ### 3. Create a `ManagedControlPlane` in the `Workspace` | ||
|
|
||
| The `ManagedControlPlane` resource is the heart of the openMCP platform. A Managed Control Plane (MCP) is a representation of a Kubernetes API. With the `ManagedControlPlane` you specify the Users that get access via ClusterRoles or Roles to the Kubernetes API of the MCP. | ||
maximiliantech marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```yaml | ||
| apiVersion: core.openmcp.cloud/v2alpha1 | ||
| kind: ManagedControlPlaneV2 | ||
| metadata: | ||
| name: mcp-01 | ||
| namespace: project-platform-team--ws-dev | ||
| spec: | ||
| iam: | ||
| roleBindings: | ||
| - subjects: | ||
| - kind: User | ||
| name: [email protected] | ||
| - kind: User | ||
| name: [email protected] | ||
| roleRefs: | ||
| - kind: ClusterRole | ||
| name: cluster-admin | ||
| ``` | ||
|
|
||
| ### 4. Install managed services in your Managed Control Plane (MCP) | ||
|
|
||
| You can install managed services in your Managed Control Plane (MCP) to extend its functionality. Currently, the following managed services are available: | ||
| - Crossplane via the [service-provider-crossplane](https://github.com/openmcp-project/service-provider-crossplane) | ||
| - Landscaper via the [service-provider-landscaper](https://github.com/openmcp-project/service-provider-landscaper) | ||
|
|
||
| #### Managed Service: Crossplane | ||
|
|
||
| Crossplane is an open source project that enables you to manage cloud infrastructure and services using Kubernetes-style declarative configuration. It allows you to define and manage cloud resources such as databases, storage, and networking using Kubernetes manifests. | ||
|
|
||
| To install Crossplane in your MCP, you need to create a `Crossplane` resource in the same namespace as your `ManagedControlPlane`. The following example installs Crossplane version `v1.20.0` with the `provider-kubernetes` provider version `v0.16.0`. | ||
|
|
||
| ```yaml | ||
| apiVersion: crossplane.services.openmcp.cloud/v1alpha1 | ||
| kind: Crossplane | ||
| metadata: | ||
| name: mcp-01 # Same name as your ManagedControlPlane | ||
| namespace: project-platform-team--ws-dev # Same namespace as your ManagedControlPlane | ||
| spec: | ||
| version: v1.20.0 | ||
| providers: | ||
| - name: provider-kubernetes | ||
| version: v0.16.0 | ||
| ``` | ||
|
|
||
| #### Managed Service: Landscaper | ||
|
|
||
| Landscaper manages the installation, updates, and uninstallation of cloud-native workloads, with focus on larger complexities, while being capable of handling complex dependency chains between the individual components. | ||
|
|
||
| To install a Landscaper for your MCP, you need to create a `Landscaper` resource with the same namespace and name as your `ManagedControlPlane`. The following example installs the Landscaper with default configuration. | ||
|
|
||
| ```yaml | ||
| apiVersion: landscaper.services.openmcp.cloud/v1alpha1 | ||
| kind: Landscaper | ||
| metadata: | ||
| name: mcp-01 # Same name as your ManagedControlPlane | ||
| namespace: project-platform-team--ws-dev # Same namespace as your ManagedControlPlane | ||
| spec: {} | ||
| ``` | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.