From a13ff4fde1783200123ad52840f4d3d9aafdea1e Mon Sep 17 00:00:00 2001
From: void404 <wojciech.nawa@gmail.com>
Date: Fri, 19 Jan 2024 09:09:05 +0100
Subject: [PATCH] Document dry run flag

---
 README.md                                | 17 +++++++++++++++--
 controllers/compassmanager_controller.go |  2 +-
 2 files changed, 16 insertions(+), 3 deletions(-)

diff --git a/README.md b/README.md
index c5f9bf5..d39b533 100644
--- a/README.md
+++ b/README.md
@@ -20,8 +20,6 @@ It's main responsibilities **will be**:
 
 ## Installation
 
-## Installation
-
 1. Clone the project.
 
 ```bash
@@ -81,6 +79,21 @@ make deploy
 ```
 ## Usage
 
+### Configuration Envs
+
+| Name                               | Default                                                                      | Description                                                                        |
+|------------------------------------|------------------------------------------------------------------------------|------------------------------------------------------------------------------------|
+| `APP_ADDRESS`                      | `127.0.0.1:3000`                                                             | Adress on which the app will be exposed                                            |
+| `APP_APIENDPOINT`                  | `/graphql`                                                                   | Endpoint for GraphQL requests                                                      |
+| `APP_PLAYGROUNDAPIENDPOINT`        | `/graphql`                                                                   | This option is not used                                                            |
+| `APP_SKIPDIRECTORCERTVERIFICATION` | `false`                                                                      | Skip cert verification in Compass Director GraphQL calls                           |
+| `APP_DIRECTOR_URL`                 | `https://compass-gateway-auth-oauth.mps.dev.kyma.cloud.sap/director/graphql` | URL of the Compass Director GraphQL endpoint                                       |
+| `APP_DIRECTOR_OAUTH_PATH`          | `./dev/director.yaml`                                                        | File with OAuth data for Compass Director                                          |
+| `APP_ENABLED_REGISTRATION`         | `false`                                                                      | Enable registering runtimes with Compass                                           |
+| `APP_DRYRUN`                       | `false`                                                                      | Disable registering and configuring, instead log what operations would be executed |
+
+> **TIP:** `CompassManagerMappings` created with dry run will be labeled `kyma-project.io/cm-dry-run: Yes`
+
 > Explain how to use the project. You can create multiple subsections (H3). Include the instructions or provide links to the related documentation.
 
 ## Development
diff --git a/controllers/compassmanager_controller.go b/controllers/compassmanager_controller.go
index 2502a53..6d03e6e 100644
--- a/controllers/compassmanager_controller.go
+++ b/controllers/compassmanager_controller.go
@@ -39,7 +39,7 @@ const (
 	LabelManagedBy        = "operator.kyma-project.io/managed-by"
 	LabelShootName        = "kyma-project.io/shoot-name"
 	LabelSubaccountID     = "kyma-project.io/subaccount-id"
-	LabelDryRun           = "compass-manager-dry-run"
+	LabelDryRun           = "kyma-project.io/cm-dry-run"
 
 	ApplicationConnectorModuleName = "application-connector"
 	// KubeconfigKey is the name of the key in the secret storing cluster credentials.