Page Comparison

...

Code Block
curl http://localhost:2888/api/health (for all services)

Full API Details

Resource	Parameters	Example
`/api/properties`	(optional) `properties` list of property names to get. If none is specified the list from `application.yaml` is used.	`http://localhost:2888/api/properties`
`/api/health`	(required) `name` of the system to check health (required) `category` grouping used to check health If neither of these parameters is specified the list from `application.yaml` is used	`http://localhost:2888/api/health`
`/api/health/url`	(required) `name` or label used (required) `url` used for connection (optional) `user` to use for the connection (optional) `password` to use for the connection	`http://localhost:2888/api/health/url?url=_URL`
`/api/oauth`	(optional) `name` of the oauth grant to check (for example: `oauthcli`). If none is specified, retrieves the full list.	`http://localhost:2888/api/oauth` or `http://localhost:2888/api/oauth?name=oauthinternal`

📘 Options for updating properties

...

The preferred method is to modify the environment variables of the system directly through the preinstall tool’s Environment Variables page. If you are using SCCS, you will likely need to set spring.cloud.config.overrideSystemProperties to false using one of the other options, in order to ensure that the PIU is able to correctly update its internal state from this page.
Image RemovedImage Added
Ensure PIU is pointed to the correct SCCS (Spring Cloud Config) server in the helm configuration values.yaml file. A SCCS server is required for install so this is the best practice, however you use PIU without SCCS as noted under the Docker section above.
Update properties themselves directly. PIU will refresh properties internally when you update your browser page.
In addition (and while using options 2 or 3), you can override properties using Helm or Docker Desktop (as shown above). This is helpful if you want to override some parameters without changes to property files. You can also specify override the location for file locations themselves.

...

How do i disable / enable read write validation?

Code Block
# change this setting as desired

...


moc:

...


  preinstall:

...


    validate-write-access: true

How do I filter some checks completely from the view

Code Block
# change this setting as desired

...


moc:

...


  preinstall:

...


    included-health-checks: jenkins,jira,mongodb,rstudio,zipkin

You can also update the properties PIU scans for:

Code Block
# change this setting as desired

...


moc:

...


  preinstall:

...


    included-properties: modelop.gateway-url,modelop.ws-gateway-url,modelop.moc-center-url

How do I run the PIU in headless mode?

If you want to run the PIU in headless mode, it can be done so by adding the headless profile to the active spring profiles.

📘 Config Options

Test

Config

Example Values

Description

Url Health Indicators

moc.preinstall.urlHealthIndicators

Code Block
jenkins: url: $modelop.jenkins-url user: $modelop.jenkins-user password: $modelop.jenkins-password jira: url: $modelop.jira-url user: $modelop.jira-user password: $modelop.jira-password

Add simple URLs to test if the address is visible from the PIU.

Camunda Database Health Indicator

spring.datasource

Code Block
datasource: url: jdbc:mysql://address:3306/database username: username password: password

Test a Camunda database for connectivity.

Certificates Health Indicator

moc.preinstall.certsFileLocation

moc.preinstall.certsPassword

moc.preinstall.certsImportLogFile

Code Block
certsFileLocation: /certs/ moc.preinstall.certsPassword: password moc.preinstall.certsImportLogFile: /modelop/init/default-entrypoint.log

Properties for locating, and viewing certs available to MOC through helm installation.

Git Health Indicator

model-manage.git.storedCredentials

Code Block
storedCredentials: - context: https://github.com/ username: username password: token

Check if model-manager will have correct Git access.

Jira Attachment Health Indicator

moc.preinstall.jiraProjectKey

moc.preinstall.jiraIssueType

Code Block
jiraProjectKey: SOMEPROJECTKEY jiraIssueType: Task

Uses Jira credentials from URL Health indicators, and the additional config to create a ticket with an attachment to ensure attachments are enabled.

MongoDb Health Indicator

modelop.mongodb-uri

Code Block
mongodb://username:password@address:27017/test?authSource=admin

Test if a Mongo database URI is available from the PIU.

S3 Health Indicator

external-file-repo-config.s3:

Code Block
s3: s3-host: s3-accessKey: key s3-secretKey: secretkey s3-port: 443 s3-secure: false s3-defaultBucket:test-bucket s3-region: us-east-2

Test if s3 buckets are able to be connected to from the PIU.

Spring Cloud Config Server Health Indicator

spring.cloud.config

spring.application.profiles.active

Code Block
spring: application: profiles.active: base_secured,cognito,secured,jwt,external_file_repo_config,git_credentials,postgres cloud: config: uri: http://sccs:8097 username: username password: password

Test if the PIU tool can connect and retrieve SCCS config.

Properties Health Indicator

moc.preinstall.includedProperties

Code Block
includedProperties: spring.profiles.active,spring.cloud.config.uri,...

A list of SCCS properties to check if values exist for.

Oauth Health Indicators

moc.preinstall.oauth2.includeProxy

moc.preinstall.oauth2.issuer-uri

moc.preinstall.oauth2.authorization-uri

moc.preinstall.oauth2.token-uri

moc.preinstall.oauth2.user-info-uri

moc.preinstall.oauth2.jwks-uri moc.preinstall.oauth2.introspection-uri

moc.preinstall.oauth2.redirect-uri

moc.preinstall.oauth2.internal-client-id

moc.preinstall.oauth2.internal-client-secret

moc.preinstall.oauth2.internal-scope

moc.preinstall.oauth2.internalClaims.claim

moc.preinstall.oauth2.cli-client-id

moc.preinstall.oauth2.cli-client-secret

moc.preinstall.oauth2.cli-scope

moc.preinstall.oauth2.cliClaims.claim moc.preinstall.oauth2.gateway-client-id

moc.preinstall.oauth2.gateway-client-secret

moc.preinstall.oauth2.gateway-scope

moc.preinstall.oauth2.gatewayClaims.claim

moc.preinstall.oauth2.username

moc.preinstall.oauth2.password

Code Block

oauth2:
  issuer-uri: ${modelop.provider.issuer-uri}
  authorization-uri: ${modelop.provider.authorization-uri}
  token-uri: ${modelop.provider.token-uri}
  user-info-uri: ${modelop.provider.user-info-uri}
  jwks-uri: ${modelop.provider.jwk-set-uri}
  introspection-uri: ${modelop.provider.introspection-uri}
  redirect-uri: ${modelop.provider.redirect-uri}
  internal-client-id: ${modelop.internal.client-id}
  internal-client-secret: ${modelop.internal.client-secret}
  internal-scope: ${modelop.internal.scope}
  cli-client-id: ${modelop.go-cli.client-id}
  cli-client-secret: ${modelop.go-cli.client-secret}
  cli-scope: ${modelop.go-cli.scope}
  gateway-client-id: ${modelop.gateway.client-id}
  gateway-client-secret: ${modelop.gateway.client-secret}
  gateway-scope: ${modelop.gateway.scope}
  internalClaims:
    scope: modelop_client
  cliClaims:
    scope: openid,profile,email
    memberOf: modelop
    given_name: Jane
  gatewayClaims:
    scope: openid,profile,email,offline_access
    memberOf: modelop
    given_name: Jane
  username: jane
  password: doe

Check several Oauth claims and calls. These values should be primarily filled in via references to the values intended to be used to populate MOC. See Supported OAuth 2.0 Identity Providers for more info.

moc.preinstall.checkWriteAccess

true, false

Check whether write access is accepted for Camunda and Mongo databases.

moc.preinstall.performanceTest

true, false

Do a small performance test in the Camunda database to see gain a small amount of insight into performance for read write operations.

moc.preinstall.latencyChecks

true, false

Repeat checks 10 times and average them to gain a small amount of insight into the latency of certain connections to PIU.

moc.preinstall.includedHealthChecks:

required

optional

exclusive

Code Block
includedHealthChecks: required: mongodb,camundadatabase,sccs optional: git,jenkins,jira,rstudio,zipkin,s3 exclusive: jiraattachment

Set which checks PIU should have enabled. Note: its recommended to have Jira attachment as its own category in the exclusive category so its not run with all health tests in general.

spring.cloud.config.overrideSystemProperties

true, false

This setting set to false, enables the system to not be overrode by spring config. This allows for immediate testing of values via changing the environment variables in the jvm.

moc.preinstall.headlessCerts

true, false

Disable or enable cert printing in headless mode.

Versions Compared

Old Version 1

New Version Current

Key

📘 Options for updating properties

📘 Config Options