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

Adding component-specific self-signed cert info for IDE and Pipelines. #222

Merged
8 changes: 8 additions & 0 deletions assemblies/working-with-certificates.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,13 @@ include::modules/removing-a-ca-bundle-from-a-namespace.adoc[leveloffset=+1]

include::modules/managing-certificates.adoc[leveloffset=+1]

== Using self-signed certificates with {productname-short} components

Some {productname-short} components have additional options or required configuration for self-signed certificates.

include::modules/using-certificates-with-data-science-pipelines.adoc[leveloffset=+2]

include::modules/using-certificates-with-workbenches.adoc[leveloffset=+2]

ifdef::parent-context[:context: {parent-context}]
ifndef::parent-context[:!context:]
86 changes: 86 additions & 0 deletions modules/using-certificates-with-data-science-pipelines.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
:_module-type: PROCEDURE

[id='using-certificates-with-data-science-pipelines_{context}']
= Using certificates with data science pipelines

== Providing a CA bundle only for data science pipelines

Perform the following steps to provide a Certificate Authority (CA) bundle just for data science pipelines.

aduquett marked this conversation as resolved.
Show resolved Hide resolved
.Procedure
. Log in to {openshift-platform}.
. From *Workloads* -> *ConfigMaps*, create a ConfigMap with the required bundle in the same data science project or namespace as the target data science pipeline:
+
[source]
----
kind: ConfigMap
apiVersion: v1
metadata:
name: custom-ca-bundle
data:
ca-bundle.crt: |
# contents of ca-bundle.crt
----
. Add the following snippet to the `.spec.apiserver.caBundle` field of the underlying Data Science Pipelines Application (DSPA):
+
[source]
----
apiVersion: datasciencepipelinesapplications.opendatahub.io/v1alpha1
kind: DataSciencePipelinesApplication
metadata:
name: data-science-pipelines-definition
spec:
...
apiServer:
...
cABundle:
configMapName: custom-ca-bundle
configMapKey: ca-bundle.crt
----

The pipeline server pod redeploys with the updated bundle and uses it in the newly created pipeline pods.

.Verification

Perform the following steps to confirm that your CA bundle was successfully mounted.

. Log in to the {openshift-platform} console.
. Go to the {openshift-platform} project that corresponds to the data science project.
. Click the *Pods* tab.
. Click the pipeline server pod with the `ds-pipeline-pipelines-definition-<hash>` prefix.
. Click *Terminal*.
. Enter `cat /dsp-custom-certs/dsp-ca.crt`.
. Verify that your CA bundle is present within this file.

You can also confirm that your CA bundle was successfully mounted by using the CLI:

. In a terminal window, log in to the OpenShift cluster where {productname-short} is deployed.
+
----
oc login
----
. Set the `dspa` value:
+
----
dspa=pipelines-definition
----
. Set the `dsProject` value, replacing `$YOUR_DS_PROJECT` with the name of your data science project:
+
----
dsProject=$YOUR_DS_PROJECT
----
. Set the `pod` value:
+
----
pod=$(oc get pod -n ${dsProject} -l app=ds-pipeline-${dspa} --no-headers | awk '{print $1}')
----
. Display the contents of the `/dsp-custom-certs/dsp-ca.crt` file:
+
----
oc -n ${dsProject} exec $pod -- cat /dsp-custom-certs/dsp-ca.crt
----
. Verify that your CA bundle is present within this file.

== Creating data science pipelines with Elyra and self-signed certificates

To create pipelines using a workbench that contains the Elyra extension and which uses self-signed certificates, see the link:https://access.redhat.com/solutions/7046302[Workbench workaround for executing a pipeline using Elyra in a disconnected environment] knowledgebase article.
24 changes: 24 additions & 0 deletions modules/using-certificates-with-workbenches.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
:_module-type: PROCEDURE

[id='using-certificates-with-workbenches_{context}']
= Using certificates with workbenches

[IMPORTANT]
====
ifdef::upstream[]
Self-signed certificates apply to workbenches that you create after configuring self-signed certificates centrally as described in link:{odhdocshome}/installing-open-data-hub/#understanding-certificates_certs[Understanding certificates in {productname-short}]. There is no change to workbenches that you created before configuring self-signed certificates.
endif::[]
ifndef::upstream[]
ifdef::cloud-service[]
Self-signed certificates apply to workbenches that you create after configuring self-signed certificates centrally as described in link:{rhoaidocshome}{default-format-url}/installing_and_uninstalling_{url-productname-short}/working-with-certificates_certs[Working with certificates]. There is no change to workbenches that you created before configuring self-signed certificates.
endif::[]
ifdef::self-managed[]
Self-signed certificates apply to workbenches that you create after configuring self-signed certificates centrally as described in link:{rhoaidocshome}{default-format-url}/installing_and_uninstalling_{url-productname-short}/working-with-certificates_certs[Working with certificates] (for disconnected environments, see link:{rhoaidocshome}{default-format-url}/installing_and_uninstalling_{url-productname-short}_in_a_disconnected_environment/working-with-certificates_certs[Working with certificates]. There is no change to workbenches that you created before configuring self-signed certificates.
endif::[]
endif::[]
====

== Creating data science pipelines with Elyra and self-signed certificates
aduquett marked this conversation as resolved.
Show resolved Hide resolved

To create pipelines using a workbench that contains the Elyra extension and which uses self-signed certificates, see the link:https://access.redhat.com/solutions/7046302[Workbench workaround for executing a pipeline using Elyra in a disconnected environment] knowledgebase article.