Skip to content

Commit

Permalink
docs(readme): document secrets randomization (#350)
Browse files Browse the repository at this point in the history
* docs(readme):  Add notes about randomized keys and credentials
  • Loading branch information
david-leifker authored Aug 15, 2023
1 parent bd670a9 commit 30eee99
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,26 @@ kubectl port-forward <datahub-frontend pod name> 9002:9002
You should be able to access the frontend via http://localhost:9002.

Once you confirm that the pods are running well, you can set up ingress for datahub-frontend
to expose the 9002 port to the public.
to expose the 9002 port to the public.

## Default Credentials

There are a few keys and credentials created as part of the deployment using randomized values. They can be overridden using various configuration parameters.

Also consider changing the default credentials used by any of the underlying data stores pulled in by the companion helm chart for
the prerequisites. Refer to the upstream helm charts or point to your own managed data stores for these components.

### DataHub Login

For controlling the default admin password, see the following [configuration](charts/datahub/values.yaml#L36).

### Encryption Key

Used by the Play framework and GMS to encrypt secrets at the application level, this can be configured [here](charts/datahub/values.yaml#L579).

### Token Signing Key

Used to sign tokens for authentication, see configuration [here](charts/datahub/values.yaml#L605).

## Contributing

Expand Down

0 comments on commit 30eee99

Please sign in to comment.