Skip to content

Commit

Permalink
Document dry run flag
Browse files Browse the repository at this point in the history
  • Loading branch information
VOID404 committed Jan 19, 2024
1 parent ca1630d commit a13ff4f
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@ It's main responsibilities **will be**:

## Installation

## Installation

1. Clone the project.

```bash
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion controllers/compassmanager_controller.go
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit a13ff4f

Please sign in to comment.