20
20
21
21
## Introduction
22
22
23
- The NBDE Tang server operator helps to provide [ NBDE] ( https://access.redhat.com/articles/6987053 )
23
+ The NBDE Tang server operator provides [ NBDE] ( https://access.redhat.com/articles/6987053 )
24
24
technology for OpenShift/K8S. It deploys one or several Tang servers automatically.
25
25
The Tang server container image to launch is configurable, and will use the latest one
26
- available by default. This operator has been developed using [ operator-sdk] ( https://sdk.operatorframework.io/ ) .
26
+ available by default. This operator has been developed using [ operator-sdk] ( https://sdk.operatorframework.io/ )
27
+ framework.
27
28
28
29
The operator avoids having to follow all Tang manual installation steps,
29
30
and leverages some of the features provided by OpenShift: multi-replica deployment,
@@ -36,8 +37,8 @@ if executed manually. Examples of these operations are:
36
37
- key rotation
37
38
- hidden keys deletion
38
39
39
- Up to date, it can be deployed as a CRD, containing its proper
40
- configuration values to perform appropriate Tang server operations.
40
+ Up to date, it is deployed through a CRD (Custom Resource Definition),
41
+ containing its proper configuration values to perform appropriate Tang server operations.
41
42
42
43
An introductory video can be seen in next link:
43
44
[ NBDE in OpenShift: tang-operator basics] ( https://youtu.be/hmMSIkBoGoY )
@@ -108,7 +109,7 @@ OpenShift client to install is `oc`, whose installation can be
108
109
checked in the [ Links] ( #links ) section.
109
110
110
111
Once OpenShift/K8S cluster is installed, operator can be installed
111
- with operator-sdk.
112
+ through operator-sdk.
112
113
operator-sdk installation is described in the [ Links] ( #links ) section.
113
114
114
115
In order to deploy the latest version of the operator, check latest released
@@ -125,12 +126,12 @@ To install latest multi-arch image, execute:
125
126
$ operator-sdk run bundle quay.io/sec-eng-special/tang-operator-bundle:multi-arch
126
127
```
127
128
128
- If the message ** OLM has successfully installed** is displayed, it is normally a
129
- sign of a proper installation of the operator.
129
+ If the message ** OLM has successfully installed** is displayed, it is a sign of a
130
+ proper installation of the operator.
130
131
131
132
If a message similar to ** "failed open: failed to do request: context deadline exceeded"** ,
132
- it is possible that a timeout is taking place. Try to increase the timeout in case
133
- your cluster takes long time to deploy. To do so, the option ** --timeout** can be
133
+ is shown, it is possible that a timeout is taking place. Try to increase the timeout values
134
+ in case your cluster takes long time to deploy. To do so, the option ** --timeout** can be
134
135
used (if not used, default time is 2m, which stands for two minutes):
135
136
136
137
``` bash
@@ -147,7 +148,7 @@ the following is observed when prompting for installed pods:
147
148
$ oc get pods
148
149
NAME READY STATUS RESTARTS AGE
149
150
dbbd1837106ec169542546e7ad251b95d27c3542eb0409c1e 0/1 Completed 0 82s
150
- quay-io-tang-nbde-tang-server-bundle-v1.1.0 1/1 Running 0 90s
151
+ quay-io-tang-nbde-tang-server-bundle-v1.1.0 1/1 Running 0 90s
151
152
nbde-tang-server-controller-manager-5c9488d8dd-mgmsf 2/2 Running 0 52s
152
153
```
153
154
@@ -163,7 +164,7 @@ namespace/nbde created
163
164
tangserver.nbde.openshift.io/tangserver created
164
165
```
165
166
166
- In case operator is appropriately executed , ** nbde** namespace should contain
167
+ In case operator is appropriately configured , ** nbde** namespace should contain
167
168
the service, deployment and its related pods:
168
169
169
170
```
0 commit comments