Skip to content

Commit

Permalink
Update README.md (#38)
Browse files Browse the repository at this point in the history
<!-- Thank you for your contribution. Before you submit the pull
request:
1. Follow contributing guidelines, templates, the recommended Git
workflow, and any related documentation.
2. Read and submit the required Contributor Licence Agreements
(https://github.com/kyma-project/community/blob/main/CONTRIBUTING.md#agreements-and-licenses).
3. Test your changes and attach their results to the pull request.
4. Update the relevant documentation.

If the pull request requires a decision, follow the [decision-making
process](https://github.com/kyma-project/community/blob/main/governance.md)
and replace the PR template with the [decision record
template](https://github.com/kyma-project/community/blob/main/.github/ISSUE_TEMPLATE/decision-record.md).
-->

**Description**

Add necessary information about Compass Manager
Changes proposed in this pull request:

- ...
- ...
- ...

**Related issue(s)**
<!-- If you refer to a particular issue, provide its number. For
example, `Resolves #123`, `Fixes #43`, or `See also #33`. -->
  • Loading branch information
kyma-bot authored Oct 27, 2023
2 parents d387cd7 + 011ec62 commit 10d6039
Showing 1 changed file with 68 additions and 11 deletions.
79 changes: 68 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,83 @@

# Compass Manager

> Modify the title and insert the name of your project. Use Heading 1 (H1).
## Overview
Compass Manager **will be** a new Control Plane component. Build using [Kubebuilder](https://github.com/kubernetes-sigs/kubebuilder) framework.

> Provide a description of the project's functionality.
>
> If it is an example README.md, describe what the example illustrates.
It's main responsibilities **will be**:
- registering Kyma runtimes in the Compass Director
- creating secret on client cluster with the Compass Runtime configuration

## Prerequisites

> List the requirements to run the project or example.
- Golang - minimum version is 1.20.
- Access to a k8s cluster.
- Kyma Custom Resource Definition is present on cluster.
- [k3d](https://k3d.io) to get a local cluster for testing, or run against a remote cluster.
- [kubectl](https://kubernetes.io/docs/tasks/tools/)
- [kubebuilder](https://book.kubebuilder.io/)

## Installation

> Explain the steps to install your project. Create an ordered list for each installation task.
>
> If it is an example README.md, describe how to build, run locally, and deploy the example. Format the example as code blocks and specify the language, highlighting where possible. Explain how you can validate that the example ran successfully. For example, define the expected output or commands to run which check a successful deployment.
>
> Add subsections (H3) for better readability.
## Installation

1. Clone the project.

```bash
git clone https://github.com/kyma-project/compass-manager.git && cd compass-manager/
```

2. Set the `compass-manager` image name. Add prefix `your-docker-hub-user/` if needed

```bash
export IMG=custom-compass-manager:local
```

3. Build the project.

```bash
make build
```

4. Build the image.

```bash
make docker-build
```

5. Push the image to the external DockerHub registry.

```bash
make docker-push
```

6. Create a YAML file containing Compass Director authorization data and encode entire YAML in Base64 format:

```yaml
data:
client_id: some-id
client_secret: some-secret
tokens_endpoint: some-endpoint
```
7. Provide previously encoded file in `director.yaml` field and apply the secret on cluster where you want to run Compass Manager

```yaml
apiVersion: v1
kind: Secret
metadata:
name: kcp-provisioner-credentials-file
namespace: kcp-system
type: Opaque
data:
director.yaml: base64-encoded-yaml
```

8. Deploy.

```bash
make deploy
```
## Usage

> Explain how to use the project. You can create multiple subsections (H3). Include the instructions or provide links to the related documentation.
Expand Down

0 comments on commit 10d6039

Please sign in to comment.