.. Copyright 2020 NOKIA
How to use functionality
-========================
+=========================
+Common information to docker and Kubernetes modes described below
Basic information
-----------------
-Certification Client needs the following configuration parameters to work properly:
+CertService client needs the following configuration parameters to work properly:
-1. Parameters for connection to certification service API and generate trustore and keystore
+1. Parameters for connection to CertService API to obtain certificate and trust anchors
- - REQUEST_URL *(default: https://aaf-cert-service:8443/v1/certificate/)*
- - REQUEST_TIMEOUT *(default: 30000)*
- - OUTPUT_PATH *(required)*
- - CA_NAME *(required)*
+ - REQUEST_URL *(default: https://aaf-cert-service:8443/v1/certificate/)* - URL to CertService API
+ - REQUEST_TIMEOUT *(default: 30000[ms])* - Timeout in milliseconds for REST API calls
+ - OUTPUT_PATH *(required)* - Path where client will output generated certificate and trust anchor
+ - CA_NAME *(required)* - Name of CA which will enroll certificate. Must be same as configured on server side. Used in REST API calls
-2. Parameters for generate CSR file:
+2. Parameters to generate Certificate Signing Request (CSR):
- - COMMON_NAME *(required)*
- - ORGANIZATION *(required)*
- - ORGANIZATION_UNIT *(optional)*
- - LOCATION *(optional)*
- - STATE *(required)*
- - COUNTRY *(required)*
- - SANS *(optional)(SANS's should be separated by a colon)*
+ - COMMON_NAME *(required)* - Common name for which certificate from CMPv2 server should be issued
+ - ORGANIZATION *(required)* - Organization for which certificate from CMPv2 server should be issued
+ - ORGANIZATION_UNIT *(optional)* - Organization unit for which certificate from CMPv2 server should be issued
+ - LOCATION *(optional)* - Location for which certificate from CMPv2 server should be issued
+ - STATE *(required)* - State for which certificate from CMPv2 server should be issued
+ - COUNTRY *(required)* - Country for which certificate from CMPv2 server should be issued
+ - SANS *(optional)(SANS's should be separated by a colon e.g. test.onap.org:onap.com)* - Subject Alternative Names (SANs) for which certificate from CMPv2 server should be issued.
-3. Parameters for secure connection:
+3. Parameters to establish secure communication to CertService:
- KEYSTORE_PATH *(required)*
- KEYSTORE_PASSWORD *(required)*
- TRUSTSTORE_PATH *(required)*
- TRUSTSTORE_PASSWORD *(required)*
-Certification Service Client image can be find on Nexus repository :
+CertService client image can be found on Nexus repository :
.. code-block:: bash
- nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:latest
+ nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:$VERSION
As standalone docker container
------------------------------
-You need certification files to connect to certification service API via https. Information how to generate truststore and keystore files you can find in project repository README `Gerrit GitWeb <https://gerrit.onap.org/r/gitweb?p=aaf%2Fcertservice.git;a=summary>`__
+You need certificate and trust anchors to connect to CertService API via HTTPS. Information how to generate truststore and keystore files you can find in project repository README `Gerrit GitWeb <https://gerrit.onap.org/r/gitweb?p=aaf%2Fcertservice.git;a=summary>`__
-To run Certification Client as standalone docker container execute following steps:
+To run CertService client as standalone docker container execute following steps:
-1. Create file with environments as in example below:
+1. Create file '*$PWD/client.env*' with environments as in example below:
.. code-block:: bash
#Client envs
- REQUEST_URL=<url to certification service API>
+ REQUEST_URL=<URL to CertService API>
REQUEST_TIMEOUT=10000
OUTPUT_PATH=/var/certs
CA_NAME=RA
- #Csr config envs
+
+ #CSR config envs
COMMON_NAME=onap.org
ORGANIZATION=Linux-Foundation
ORGANIZATION_UNIT=ONAP
STATE=California
COUNTRY=US
SANS=test.onap.org:onap.com
- #Tls config envs
+
+ #TLS config envs
KEYSTORE_PATH=/etc/onap/aaf/certservice/certs/certServiceClient-keystore.jks
- KEYSTORE_PASSWORD=<password to keystore.jks>
+ KEYSTORE_PASSWORD=<password to certServiceClient-keystore.jks>
TRUSTSTORE_PATH=/etc/onap/aaf/certservice/certs/certServiceClient-truststore.jks
TRUSTSTORE_PASSWORD=<password to certServiceClient-truststore.jks>
docker run \
--rm \
--name aafcert-client \
- --env-file <path to environments file> \
+ --env-file <$PWD/client.env (same as in step1)> \
--network <docker network of cert service> \
- --mount type=bind,src=<path to local directory>,dst=<OUTPUT_PATH> \
- --volume <local path to keystore.jks>:<KEYSTORE_PATH> \
- --volume <local path to trustore.jks>:<TRUSTSTORE_PATH> \
- nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:latest
+ --mount type=bind,src=<path to local host directory where certificate and trust anchor will be created>,dst=<OUTPUT_PATH (same as in step 1)> \
+ --volume <local path to keystore in JKS format>:<KEYSTORE_PATH> \
+ --volume <local path to truststore in JKS format>:<TRUSTSTORE_PATH> \
+ nexus3.onap.org:10001/onap/org.onap.aaf.certservice.aaf-certservice-client:$VERSION
-After successful creation of certifications, container exits with exit code 0, expected logs looks like:
+After successful creation of certifications, container exits with exit code 0, expected log looks like:
.. code-block:: bash
As init container for Kubernetes
--------------------------------
-To run Certification Client as init container for ONAP component, add following configuration to deploymnet:
+In order to run CertService client as init container for ONAP component you need to:
+
+ - define an init container and use CerService Client image
+ - provide client configuration through ENV variables in the init container
+ - define two volumes:
+
+ - first for generated certificates - it will be mounted in the init container and in the component container
+ - second with secret containing keys and certificates for secure communication between CertService Client and CertService - it will be mounted only in the init container
+ - mount both volumes to the init container
+ - mount first volume to the component container
+
+You can use the following deployment example as a reference:
.. code-block:: yaml
value: US
- name: SANS
value: test.onap.org:onap.com
+ - name: KEYSTORE_PATH
+ value: /etc/onap/aaf/certservice/certs/certServiceClient-keystore.jks
+ - name: KEYSTORE_PASSWORD
+ value: secret
+ - name: TRUSTSTORE_PATH
+ value: /etc/onap/aaf/certservice/certs/truststore.jks
+ - name: TRUSTSTORE_PASSWORD
+ value: secret
volumeMounts:
- mountPath: /var/certs
name: certs
+ - mountPath: /etc/onap/aaf/certservice/certs/
+ name: tls-volume
...
volumes:
- -emptyDir: {}
- name: certs
+ - name: certs
+ emptyDir: {}
+ - name tls-volume
+ secret:
+ secretName: aaf-cert-service-client-tls-secret # Value of global.aaf.certService.client.secret.name
...
\ No newline at end of file
Code Review / oom / platform / cert-service.git / blobdiff