Skip to content

Commit

Permalink
Revert "refactor(saas): Renaming of Endpoints and Component"
Browse files Browse the repository at this point in the history
This reverts commit c65a216.
  • Loading branch information
martinfkaeser committed Feb 16, 2023
1 parent c243a6a commit 7f0d88b
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 11 deletions.
9 changes: 5 additions & 4 deletions charts/gate/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,24 @@ This Helm Chart deploys the BPDM Gate service to a Kubernetes environment.

* [Kubernetes Cluster](https://kubernetes.io)
* [Helm](https://helm.sh/docs/)
* CDQ Storage and datasource
* SaaS storage and datasource
* Running BPDM Pool instance

For the default deployment you need to specify a valid CDQ storage, datasource and API key for the application to connect with.
For the default deployment you need to specify a valid SaaS hostname, storage, datasource and API key for the application to connect with.
The easiest way to provide this information is by creating your own values files and overwrite the default `applicationConfig` and `applicationSecrets` values.

my_release-values.yaml:

```yaml
applicationConfig:
bpdm:
cdq:
saas:
host: https://saas
storage: your_storage_id
datasource: your_datasource_id
applicationSecrets:
bpdm:
cdq:
saas:
api-key: your_api_key
```
Expand Down
2 changes: 1 addition & 1 deletion charts/gate/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -109,5 +109,5 @@ applicationConfig:
# Used to overwrite the secret property values of the application configuration
applicationSecrets:
# bpdm:
# cdq:
# saas:
# api-key: ...
12 changes: 6 additions & 6 deletions charts/pool/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ helm install release_name ./charts/pool --namespace your_namespace

This will install a new release of the BPDM Pool in the given namespace.
On default values this release deploys the latest image tagged as `main` from the repository's GitHub Container Registry.
The application is run on default profile (without authorization and CDQ connection).
The application is run on default profile (without authorization and SaaS connection).
Additionally, the Helm deployment contains a PostgreSQL database and Opensearch instance which the BPDM Pool connects to.

On the default values deployment no further action is needed to make the BPDM Pool deployment run.
However, per default ingress is disabled, as well as no authentication for endpoints and no import from CDQ.
However, per default, ingress as well as authentication for endpoints and import from SaaS are all disabled.

By giving your own values file you can configure the Helm deployment of the BPDM Pool freely:

Expand All @@ -45,12 +45,12 @@ image:
## Profiles
You can also activate Spring profiles in which the BPDM Pool should be run.
In case you want to run the Pool with authorization and CDQ connection enabled you can write the following:
In case you want to run the Pool with authorization and SaaS connection enabled you can write the following:
```yaml
springProfiles:
- auth
- cdq
- saas
```
## Ingress
Expand All @@ -76,9 +76,9 @@ ingress:
## Pool Configuration
The Helm deployment comes with the ability to configure the BPDM Pool application directly over the values file.
This way you are able to overwrite any configuration property of the `application.properties`, `application-auth.properties` and `application-cdq.properties`
This way you are able to overwrite any configuration property of the `application.properties`, `application-auth.properties` and `application-saas.properties`
files.
Consider that you would need to turn on `auth` and `cdq` profile first before overwriting any property in the corresponding properties file could take effect.
Consider that you would need to turn on `auth` and `saas` profile first before overwriting any property in the corresponding properties file could take effect.
Overwriting configuration properties can be useful to connect to a remote service:

```yaml
Expand Down

0 comments on commit 7f0d88b

Please sign in to comment.