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.

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

feat: add newly redesigned jans-client-api #1540

Merged
merged 5 commits into from
Jun 13, 2022
Merged

feat: add newly redesigned jans-client-api #1540

merged 5 commits into from
Jun 13, 2022

Conversation

iromli
Copy link
Contributor

@iromli iromli commented Jun 10, 2022

Description

The changeset adds/updates several areas listed below:

  • jans-client-api is updated
  • added Jetty 11 to run jans-client-api
  • added new env var CN_CLIENT_API_CERT_CN to gradually replace deprecated CN_CLIENT_API_APPLICATION_CERT_CN and CN_CLIENT_API_ADMIN_CERT_CN
  • updated Helm charts

Note: the env var CN_CLIENT_API_APPLICATION_CERT_CN is used as backward-compat. An ideal upgrade involves removing the env var and use CN_CLIENT_API_CERT_CN instead.

Overview:

- jans-client-api is now running behind jetty server
- add new env var CN_CLIENT_API_CN_CERT to gradually replace CN_CLIENT_API_APPLICATION_CERT_CN
- CN_CLIENT_API_APPLICATION_CERT_CN and CN_CLIENT_API_ADMIN_CERT_CN are deprecated
@iromli iromli requested a review from moabu as a code owner June 10, 2022 15:16
@mo-auto mo-auto added area-CI Issue or changes required in automatic builds or CI infrastructure area-documentation Documentation needs to change as part of issue or PR comp-charts-jans comp-docker-jans-client-api kind-feature Issue or PR is a new feature request labels Jun 10, 2022
@sonarcloud
Copy link

sonarcloud bot commented Jun 10, 2022

[jans-linux-setup] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@iromli iromli marked this pull request as draft June 10, 2022 23:06
@iromli iromli marked this pull request as ready for review June 11, 2022 06:46
@iromli
Copy link
Contributor Author

iromli commented Jun 11, 2022

@moabu PR is ready for review.

@sonarcloud
Copy link

sonarcloud bot commented Jun 13, 2022

[jans-cli] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@sonarcloud
Copy link

sonarcloud bot commented Jun 13, 2022

[jans-client-api] Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Comment on lines 54 to 63
- variable: config.configmap.cnClientApiApplicationCertCn
default: "client-api"
description: "Client API application keystore name"
description: "Client API application keystore name (deprecated in favor of config.configmap.cnClientApiCertCn)"
type: string
label: Client API application keystore name
- variable: config.configmap.cnClientApiAdminCertCn
default: "client-api"
description: "Client API admin keystore name"
description: "Client API admin keystore name (deprecated)"
type: string
label: Client API admin keystore name
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section can be removed. A deprecated note is not needed since this service was never in a working state.

Comment on lines 137 to 140
# deprecated in favor of CN_CLIENT_API_CERT_CN
CN_CLIENT_API_APPLICATION_CERT_CN: {{ .Values.configmap.cnClientApiApplicationCertCn | quote }}
# deprecated
CN_CLIENT_API_ADMIN_CERT_CN: {{ .Values.configmap.cnClientApiAdminCertCn | quote }}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section can be removed. A deprecated note is not needed since this service was never in a working state.

Comment on lines 81 to 90
"cnClientApiAdminCertCn": {
"description": "Client-api OAuth client admin certificate common name. This should be left to the default value client-api",
"description": "Client-api OAuth client admin certificate common name. This should be left to the default value client-api (deprecated)",
"type": "string",
"pattern": "^[a-z-]+$"
},
"cnClientApiApplicationCertCn": {
"description": "Client-api OAuth client application certificate common name. This should be left to the default value client-api",
"description": "Client-api OAuth client application certificate common name. This should be left to the default value client-api (deprecated in favor of cnClientApiCertCn)",
"type": "string",
"pattern": "^[a-z-]+$"
},
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove

Comment on lines 63 to 64
- `CN_CLIENT_API_APPLICATION_CERT_CN`: CommonName used in application certificate subject. This environment variable is **DEPRECATED** in favor of `CN_CLIENT_API_CERT_CN`.
- `CN_CLIENT_API_ADMIN_CERT_CN`: CommonName used in admin certificate subject. This environment variable is **DEPRECATED** and no longer used.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove

Comment on lines +95 to +103
"client_api_log_level": "INFO",
"persistence_log_target": "FILE",
"persistence_log_level": "INFO",
"persistence_duration_log_target": "FILE",
"persistence_duration_log_level": "INFO",
"ldap_stats_log_target": "FILE",
"ldap_stats_log_level": "INFO",
"script_log_target": "FILE",
"script_log_level": "INFO"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add loggers spec to chart

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-CI Issue or changes required in automatic builds or CI infrastructure area-documentation Documentation needs to change as part of issue or PR comp-charts-jans comp-docker-jans-client-api kind-feature Issue or PR is a new feature request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants