|
5 | 5 | [id="olm-enabling-operator-for-restricted-network_{context}"] |
6 | 6 | = Enabling your Operator for restricted network environments |
7 | 7 |
|
8 | | -As an Operator author, your CSV must meet the following additional requirements |
9 | | -for your Operator to run properly in a restricted network environment: |
| 8 | +As an Operator author, your Operator must meet additional requirements to run |
| 9 | +properly in a restricted network, or disconnected, environment. |
10 | 10 |
|
11 | | -* List any _related images_, or other container images that your Operator might |
| 11 | +.Operator requirements for supporting disconnected mode |
| 12 | + |
| 13 | +* In the ClusterServiceVersion (CSV) of your Operator: |
| 14 | +** List any _related images_, or other container images that your Operator might |
12 | 15 | require to perform their functions. |
13 | | -* Reference all specified images by a digest (SHA) and not by a tag. |
| 16 | +** Reference all specified images by a digest (SHA) and not by a tag. |
| 17 | +* All dependencies of your Operator must also support running in a disconnected |
| 18 | +mode. |
| 19 | +* Your Operator must not require any off-cluster resources. |
| 20 | +// TODO: Include more info w/ better steps on how to do this: |
| 21 | +//* You must understand the {product-title} proxy configuration. |
| 22 | + |
| 23 | +For the CSV requirements, you can make the following changes as the Operator |
| 24 | +author. |
| 25 | + |
| 26 | +.Prerequisites |
| 27 | + |
| 28 | +* An Operator project with a CSV. |
| 29 | + |
| 30 | +.Procedure |
14 | 31 |
|
15 | | -You must use SHA references to related images in two places in the Operator's |
16 | | -CSV: |
| 32 | +. Use SHA references to related images in two places in the CSV for your Operator: |
17 | 33 |
|
18 | | -* in `spec.relatedImages`: |
| 34 | +.. Update `spec.relatedImages`: |
19 | 35 | + |
20 | 36 | [source,yaml] |
21 | 37 | ---- |
|
32 | 48 | <2> Specify a unique identifier for the image. |
33 | 49 | <3> Specify each image by a digest (SHA), not by an image tag. |
34 | 50 |
|
35 | | -* in the `env` section of the Operators Deployments when declaring environment |
| 51 | +.. Update the `env` section of the Operators Deployments when declaring environment |
36 | 52 | variables that inject the image that the Operator should use: |
37 | 53 | + |
38 | 54 | [source,yaml] |
|
89 | 105 | <2> Specify each image by a digest (SHA), not by an image tag. |
90 | 106 | <3> Also reference the Operator container image by a digest (SHA), not by an image tag. |
91 | 107 |
|
92 | | -* Look for the `Disconnected` annotation, which indicates that the Operator works |
93 | | -in a disconnected environment: |
| 108 | +. Add the `Disconnected` annotation, which indicates that the Operator works in a |
| 109 | +disconnected environment: |
94 | 110 | + |
95 | 111 | [source,yaml] |
96 | 112 | ---- |
|
0 commit comments