Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
breakoutModewide
languageyaml
genoslcToolServiceVersionOverride: ""
genoslcCodebeamerPluginVersionOverride: ""

global:
  # Domain of the cluster or of the external reverse proxy
  domain: "example.com" 
  
  # Setup OIDC information
  oidc:
    # OIDC Client ID registerd for this application
    clientId: ""
    # OIDC Client Secret registered for this application
    clientSecret: ""
  
  # SSL certificates
  cert:
    overrideTruststorePassword: "changeit"
    secretName: ""
    crtFullChain: ""
    key: ""

  identity:
    # OIDC Issuer URL, taken from the /.well-known/openid-configuration endpoint 
    OIDC_ISSUER: ""
  hosts:
    genoslc:
      # The subdomain where the OSLC Connector for Codebeamer will be accessible
      subdomain: "genoslc-codebeamer"  
      port: ""

env:
  tool:
    # Possible values: ""|"codebeamer"
    # Setting it to "codebeamer" will tell the helm chart to setup the Codebeamer Widget container in the pod
    # Required for a complete integration in the Codebeamer UI
    type: "codebeamer"
    # Codebeamer API URL
    # Usually it is the <codebeamer instance URL>/api/v3/ or <codebeamer instance URL>/cb/api/v3/
    adaptedToolApiUri: ""
    # URL where the Codebeamer application is accessible
    adaptedToolRootUri: ""
    # Timezone set in Codebeamer
    # See chapter 1.1.22.1 in https://codebeamer.com/cb/wiki/5848463
    adaptedToolToolTimeZone: "UTC"
    # base64 encoded technical user credentials
    # Required when if TRS is enabled
    adaptedToolTechnicalUserAuthorizationHeader: ""
    # URL where the Codebeamer Widget will be accessible;
    # Must fill the base URL of the OSLC Connector for Codebeamer
    widgetUrl: "<baseUrl>/cb"
  
  # If the flag "manualLoginRequired" is set to "true", the plugin will not attempt to automatically login the user.
  # This flag should be enabled if many users that do not have access to a third party app connected
  # via the OSLC Connector.
  manualLoginRequired: "false"
  
  configuration:# By default, the authorization #URI Givewill abe listretrieved offrom upthe toissuer 5URI
usernames of users# whichHowever, willif haveyou theneed administrationto rightconfigure tocustom changequery settingsparameters for the authorization request
# in the# OSLCyou Connector.can Inboundset detailsit andup
Outbound details can be managed only by administrators. 
    # At least one administrator user must be stated here.
    administrators: []
    # Key used to encrypt the oauth10a configuration data in the database
    oauth10aEncryptionKey# e.g. for acr_values
  # https://<auth_uri>/<path>?acr_values=<value>
  authorizationUri: ""
  
  # The introspection URI will be use to validate and retrieve token data necessary for user identification
  # Mandatory from OSLC Connector for Codebeamer 2024.09.1
  introspectionUri: ""
  
 # oidcconfiguration:
section overwrites the information set# inGive thea global.oidclist sectionof up to oidc:5 usernames of users which #will OIDChave Clientthe IDadministration registerdright forto thischange applicationsettings
    clientId:# ""in the OSLC Connector. Inbound #details OIDCand ClientOutbound Secretdetails registeredcan forbe thismanaged applicationonly by administrators. 
 clientSecret: ""  # At least #one Nameadministrator ofuser amust Kubernetesbe secret containing clientId and clientSecretstated here.
    secretNameadministrators: ""[]
  # Sets the# JWTKey claimused to beencrypt usedthe foroauth10a userconfiguration identificationdata in the #database
e.g. preferred_username, sub, oid   userNameAttributeoauth10aEncryptionKey: "preferred_username"  
  # Setsoidc section overwrites the information clientset authenticationin methodthe toglobal.oidc besection
used in theoidc:
authentication process   # ValidOIDC valuesClient are: client_secret_basic, client_secret_post, none
  # Default value is "client_secret_basicID registerd for this application
    clientId: ""
  clientAuthenticationScheme: "client_secret_basic" 
  # Sets the user info authentication method
  # valid values are: header, form, query
  userInfoAuthenticationMethod: "header"  # OIDC Client Secret registered for this application
    clientSecret: ""
    # Name of a Kubernetes secret containing clientId and clientSecret.
    secretName: ""
  # Sets the JWT claim to be used for user identification
  # e.g. preferred_username, sub, oid
  userNameAttribute: "preferred_username"
  # Sets the client authentication method to be used in the authentication process
  # Valid values are: client_secret_basic, client_secret_post, none
  # Default value is "client_secret_basic"
  clientAuthenticationScheme: "client_secret_basic" 
  # Sets the user info authentication method
  # valid values are: header, form, query
  userInfoAuthenticationMethod: "header" 
  # Sets the client scopes used in the authentication process
  # Default value "openid"
  clientScope: "openid" # comma separated list of scopes (e.g. "read, write")
  # Sets the application to use PKCE when authenticating the user https://oauth.net/2/pkce/
  # Default value is true
  # Set pkceEnabled to false if the OIDC provider does not support PKCE
  pkceEnabled: true
  
  # Sets the URL clientwhere the scopesOSLC usedConnector infor theCodebeamer authenticationis processaccessible
  # DefaultMandatory
value "openid"
  clientScope publicUri: "openid" # comma
separated list of# scopes (e.g. "read, write")
  # Sets the application to use PKCE when authenticating the user https://oauth.net/2/pkce/
  # Default value is true
  # Set pkceEnabled to false if the OIDC provider does not support PKCE
  pkceEnabled: true
  
  # Sets the URL whereSets the URL where the OSLC Connector for Codebeamer is accessible
  # URL must be <publicUri>/spa
  # Mandatory
  pluginUri: ""
  # Comma separate list of applications that are allowed to make requests to the OSLC Connector API
  # Examples:
  # Third party applications that connect to the OSLC Connector for Codebeamer is accessible
  # MandatoryCodebeamer
  publicUriallowedCorsOrigins: ""  
  # SetsURLs the URL where theof other OSLC ConnectorConnectors for Codebeamer is accessible
  # URL must be <publicUri>/spa
  # Mandatory
  pluginUri: ""
  # Comma separate list of applications that are allowed to make requests to the OSLC Connector API
  # Examples:
  # Third party applications that connect to the OSLC Connector for Codebeamer
  # Codebeamer
  allowedCorsOrigins(Smartfacts, Jama, PREEvision, Octane, DOORS Classic) that are connected
  # to this instance via an association. 
  knownContextRoots: ""
  # Sets the Global Configuration provider
  # Example: https://<ibm-elm>:9443/gc
  # Optional
  # Required if IBM ELM link validity is used 
  globalConfigurationProvider: ""
  # URLsSets ofthe othertype OSLCof Connectorslink (Smartfacts, Jama, PREEvision, Octane, DOORS Classic) that are connected
  # to this instance via an association. 
  knownContextRootsindex used
  # type: "ibm-elm", "smartfacts", "none"
  linkIndexType: ""
  # Sets the URI of the Globallink Configurationindex provider
  # Example:e.g https://<ibm-elm>:9443/ldx/gcsparql
  # Optional
  # Required if IBM ELM link validity is used 
  globalConfigurationProvider: ""linkIndexUri: ""
  
  # Sets the Link Validity Provider
  # Examples:
  # https://<ibm-elm>:9443/jts/elm
  # https://<smartfacts>/platform/elm
  linkValidityProvider: ""
  # Enables TRS feed generation
  # Requires a technical user to be set if it's enabled
  # TRS feed exposes base artifacts and changes occurend in syncronized Codebeamer projects
  # Enable it only if a third party tool is accessing the TRS feed of this OSLC Connector to index data
  trsEnabled: false
  
  containerPort: "8443"
  port: "8443"
  debugPortToolService: ""
  
  # Defines a proxy used by the OSLC Connector for Codebeamer. 
  proxy:
    https:
      # The URL of the https proxy server
      host: "" 
      # The port of the https proxy server
      port: ""
      # A list of IP addresses or URLs devided by the pipe sign '|'
      nonProxyHosts: "" 

  # Sets the logging level in the application
  # valid values are: INFO, ERROR, DEBUG, TRACE
  loggingLevelSpringFramework: "INFO" 


ingress:
  enabled: true
  className: ""
  annotations: {}
  tls:
    secretName: ""


  # ----------------------------------------------------------------
  # ------------------------- Library ------------------------------
  # ----------------------------------------------------------------

# Special certtool configuration
certtool:
  # certtool should only be activated on the first deployment and after a certificate update
  enabled: true
  
mongodb
  # Deployes a mongodb container inside the pod that the OSLC Connector will use
  enabled: true

...