{"type":"doc","content":[{"type":"heading","attrs":{"level":1},"content":[{"text":"Prepare the Deployment","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Add library Repository for the OSLC Connector for PREEvision","type":"text"}]},{"type":"paragraph","content":[{"text":"You will need a username and password to download the helm chart and containers from MID's repository. You will receive username and password from your MID contact or from ","type":"text"},{"text":"cops@mid.de","type":"text","marks":[{"type":"link","attrs":{"href":"mailto:cops@mid.de"}}]},{"text":".","type":"text"}]},{"type":"codeBlock","content":[{"text":"sudo helm repo add library https://repo.secure.mid.de/chartrepo/library --username --password ","type":"text"}]},{"type":"codeBlock","content":[{"text":"sudo helm repo update","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Customize Values File","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Change to your user's home directory on the server and create a new text file ","type":"text"},{"text":"preevision_values.yaml","type":"text","marks":[{"type":"code"}]},{"text":" with the following content:","type":"text"}]}]}]},{"type":"codeBlock","content":[{"text":"genoslcToolServiceVersionOverride: \"\" #use this to overwrite the default OSLC Connector for PREEvision version\nglobal:\n domain: \"\"\n instance: \"\"\n cert:\n crtFullChain: \"\"\n key: \"\"\n oidc:\n clientId: \"\"\n clientSecret: \"\"\n hosts:\n genoslc:\n subdomain: \"\"\n secrets:\n oauth2:\n wellknown: \"\"\n identity:\n OIDC_ISSUER: \"\"\ningress:\n enabled: true\n # if you use nginx as ingress controller please uncomment in this line:\n #ingressClassType: \"nginx\"\ntoolservice:\n livenessProbe:\n enabled: false\n startupProbe:\n enabled: false\n readinessProbe:\n enabled: false\n\nenv:\n clientScope: \"openid \" #default value is openid\n userNameAttribute: \"\" #default is preferred_username\n allowedCorsOrigins: \"\"\n adaptedToolRootUri: \"\"\n adaptedToolRoles: \"\"\n getProductlinesRequs: \" # replace this value with the username of the person who should configure the oauth10a information for the OSLC Connector for PREEvision\n # technical role to be used for authentication# key used to encrypt the oauth10a configuration data\n oauth10aEncryptionKey: \"\" # define the key which is used to encrypt the oauth10a informatin in the database\n\nmongodb:\n enabled: true\ncerttool:\n enabled: true","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Install the OSLC Connector for PREEvision","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Execute the Installation","type":"text"}]},{"type":"paragraph","content":[{"text":"Enter the following command to execute the Installation:","type":"text"}]},{"type":"codeBlock","content":[{"text":"sudo helm upgrade --install genoslc-preevision library/genoslc -f preevision_values.yaml -n genoslc-preevision --create-namespace","type":"text"}]},{"type":"paragraph"},{"type":"heading","attrs":{"level":1},"content":[{"text":"FAQ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"What is the OIDC configuration? ","type":"text"}]},{"type":"paragraph","content":[{"text":"The OIDC configuration refers to the oauth2.0 client. You must protect the access to OSLC Connector for PREEvision using an oauth2.0 client configured in the Identity Provider of your choice (Azure AD, Keycloak, Ping .etc). OSLC Connector for PREEvisions uses ","type":"text"},{"text":"authorization_code","type":"text","marks":[{"type":"link","attrs":{"href":"https://oauth.net/2/grant-types/authorization-code/"}}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Can I use OSLC Connector for PREEvision without an oauth2.0 authorization?","type":"text"}]},{"type":"paragraph","content":[{"text":"No","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Can we connect one instance of OSLC Connector for PREEvision to multiple instances of PREEvision?","type":"text"}]},{"type":"paragraph","content":[{"text":"No. OSLC Connector for PREEvision can connect to only one PREEvision instance specified through the API URL in ","type":"text"},{"text":"adaptedToolApiUri","type":"text","marks":[{"type":"code"}]},{"text":". Additionally the connection is available only for one model, specified through ","type":"text"},{"text":"adaptedModel","type":"text","marks":[{"type":"code"}]},{"text":" in the values file. ","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"How does the user authenticate against the PREEvision API? ","type":"text"}]},{"type":"paragraph","content":[{"text":"The user credentials are requested after the oauth2.0 authentication succeeded, as a secondary login step. The user is presented with a form where he can introduce the username, password and select one of the roles made available via the ","type":"text"},{"text":"adaptedToolRoles","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported