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.

Sign up for GitHub

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

Document dry run flag #99

Merged
merged 2 commits into from
Jan 23, 2024
+15 −4
Merged

Document dry run flag #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a13ff4f
Document dry run flag
VOID404 Jan 19, 2024
677f828
Apply suggestions from code review
VOID404 Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
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,20 @@ make deploy
```
## Usage

### Configuration Envs

| Name | Default | Description |
|------------------------------------|------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|
| `APP_ADDRESS` | `127.0.0.1:3000` | Address on which the app is exposed |
| `APP_APIENDPOINT` | `/graphql` | Endpoint for GraphQL requests |
| `APP_SKIPDIRECTORCERTVERIFICATION` | `false` | Skips cert verification in the 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 which operations would be executed |

> **TIP:** `CompassManagerMappings` created with dry run are 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
View file
Open in desktop
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
1 change: 0 additions & 1 deletion main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ var (
type config struct {
Address string `envconfig:"default=127.0.0.1:3000"`
APIEndpoint string `envconfig:"default=/graphql"`
PlaygroundAPIEndpoint string `envconfig:"default=/graphql"`
SkipDirectorCertVerification bool `envconfig:"default=false"`
DirectorURL string `envconfig:"APP_DIRECTOR_URL,default=https://compass-gateway-auth-oauth.mps.dev.kyma.cloud.sap/director/graphql"`
DirectorOAuthPath string `envconfig:"APP_DIRECTOR_OAUTH_PATH,default=./dev/director.yaml"`
Expand Down