Skip to content

Commit

Permalink
added table with additional information for environment variables
Browse files Browse the repository at this point in the history
  • Loading branch information
peters-david committed May 15, 2024
1 parent 36ee13d commit 62adf59
Showing 1 changed file with 12 additions and 24 deletions.
36 changes: 12 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -2,31 +2,19 @@
The harbor day2 operator is for automated management of existing harbor instances using python harbor-api

## Environment Variables
The following environment variables are required:
The following environment variables are expected:

|Environment Variable|Required|Example Value|Explanation|
|-------|-------|--------|-------|
|`ADMIN_USERNAME`|required (defaults to `admin` if not given)|admin|Username of the administrator account used to login via API. The default is `admin`.|
|`ADMIN_PASSWORD_OLD`|not required|***|The administrator password used previously. If the harbor administrator account password has not yet been updated, both `ADMIN_PASSWORD_OLD` and `ADMIN_PASSWORD_NEW` are required and used to update the admin account password to the `ADMIN_PASSWORD_NEW`.|
|`ADMIN_PASSWORD_NEW`|required|***|The new administrator password. If the harbor administrator account password has already been updated to the `ADMIN_PASSWORD_NEW` nothing changes.|
|`HARBOR_API_URL`|required|https://harbor.domain.com/api/v2.0/|The full Harbor API URL.|
|`CONFIG_FOLDER_PATH`|required|/usr/local/scripts|The path to the folder containing all configuration files. The files are defined and documented in the harbor repository. The path depends on how the `harbor-day2-operator` is deployed.|
|`ROBOT_NAME_PREFIX`|not required|robot$|The prefix used in all robot names.|
|`OIDC_STATIC_CLIENT_TOKEN`|required|***|The OIDC provider secret.|
|`OIDC_ENDPOINT`|required|https://oidc.domain.com/api|The endpoint of the OIDC provider.|

`ADMIN_USERNAME`
Username of the administrator account used to login via API. The default is `admin`.

`ADMIN_PASSWORD_OLD`
The administrator password used previously. If the harbor administrator account password has not yet been updated, both `ADMIN_PASSWORD_OLD` and `ADMIN_PASSWORD_NEW` are required and used to update the admin account password to the `ADMIN_PASSWORD_NEW`.

`ADMIN_PASSWORD_NEW`
The new administrator password. If the harbor administrator account password has already been updated to the `ADMIN_PASSWORD_NEW` nothing changes.

`HARBOR_API_URL`
The full Harbor API URL.

`CONFIG_FOLDER_PATH`
The path to the folder containing all configuration files. The files are defined and documented in the harbor repository.

`ROBOT_NAME_PREFIX`
The prefix used in all robot names.

`OIDC_STATIC_CLIENT_TOKEN`
The OIDC provider secret.

`OIDC_ENDPOINT`
The endpoint of the OIDC provider.

## Linter
We have activated linter like hadolint for dockerfiles. Please run

0 comments on commit 62adf59

Please sign in to comment.