Skip to content

Commit

Permalink
Merge pull request projectcalico#4481 from tmjd/update-oprtr-crd-api
Browse files Browse the repository at this point in the history 
Updating operator CRD and reference
  • Loading branch information
@tmjd
tmjd authored Mar 18, 2021
2 parents 3fee2aa + 77da367 commit f2f228d
Show file tree
Hide file tree
Showing 4 changed files with 103 additions and 42 deletions.
3 changes: 1 addition & 2 deletions _includes/charts/tigera-operator/crds/operator.tigera.io_imagesets_crd.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,7 @@ spec:
digest:
description: Digest is the image identifier that will be used
for the Image. The field should not include a leading `@`
and must be prefixed with `sha256:`, if other digest prefixes
are needed please submit a feature request.
and must be prefixed with `sha256:`.
type: string
image:
description: Image is an image that the operator deploys and
Expand Down
35 changes: 27 additions & 8 deletions _includes/charts/tigera-operator/crds/operator.tigera.io_installations_crd.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,7 @@ spec:
signerName:
description: 'When a CSR is issued to the certificates.k8s.io
API, the signerName is added to the request in order to accommodate
for clusters with multiple signers. Must be formatted as: "<my-domain>/<my-signername>".'
for clusters with multiple signers. Must be formatted as: `<my-domain>/<my-signername>`.'
type: string
required:
- caCert
Expand Down Expand Up @@ -278,7 +278,8 @@ spec:
type: object
componentResources:
description: ComponentResources can be used to customize the resource
requirements for each component.
requirements for each component. Node, Typha, and KubeControllers
are supported for installations.
items:
description: The ComponentResource struct associates a ResourceRequirements
with a component by name
Expand Down Expand Up @@ -381,7 +382,9 @@ spec:
description: "ImagePath allows for the path part of an image to be
specified. If specified then the specified value will be used as
the image path for each image. If not specified or empty, the default
for each image will be used. \n Image format: `<registry>/<imagePath>/<imageName>:<image-tag>`
for each image will be used. A special case value, UseDefault, is
supported to explicitly specify the default image path will be used
for each image. \n Image format: `<registry>/<imagePath>/<imageName>:<image-tag>`
\n This option allows configuring the `<imagePath>` portion of the
above format."
type: string
Expand Down Expand Up @@ -463,7 +466,8 @@ spec:
description: "Registry is the default Docker registry used for component
Docker images. If specified, all images will be pulled from this
registry. If not specified then the default registries will be used.
\n Image format: `<registry>/<imagePath>/<imageName>:<image-tag>`
A special case value, UseDefault, is supported to explicitly specify
the default registries will be used. \n Image format: `<registry>/<imagePath>/<imageName>:<image-tag>`
\n This option allows configuring the `<registry>` portion of the
above format."
type: string
Expand Down Expand Up @@ -575,6 +579,11 @@ spec:
type: array
type: object
type: object
typhaMetricsPort:
description: TyphaMetricsPort specifies which port calico/typha serves
prometheus metrics on. By default, metrics are not enabled.
format: int32
type: integer
variant:
description: 'Variant is the product to install - one of Calico or
TigeraSecureEnterprise Default: Calico'
Expand Down Expand Up @@ -780,7 +789,7 @@ spec:
description: 'When a CSR is issued to the certificates.k8s.io
API, the signerName is added to the request in order to
accommodate for clusters with multiple signers. Must be
formatted as: "<my-domain>/<my-signername>".'
formatted as: `<my-domain>/<my-signername>`.'
type: string
required:
- caCert
Expand Down Expand Up @@ -838,7 +847,8 @@ spec:
type: object
componentResources:
description: ComponentResources can be used to customize the resource
requirements for each component.
requirements for each component. Node, Typha, and KubeControllers
are supported for installations.
items:
description: The ComponentResource struct associates a ResourceRequirements
with a component by name
Expand Down Expand Up @@ -944,7 +954,9 @@ spec:
description: "ImagePath allows for the path part of an image to
be specified. If specified then the specified value will be
used as the image path for each image. If not specified or empty,
the default for each image will be used. \n Image format: `<registry>/<imagePath>/<imageName>:<image-tag>`
the default for each image will be used. A special case value,
UseDefault, is supported to explicitly specify the default image
path will be used for each image. \n Image format: `<registry>/<imagePath>/<imageName>:<image-tag>`
\n This option allows configuring the `<imagePath>` portion
of the above format."
type: string
Expand Down Expand Up @@ -1027,7 +1039,9 @@ spec:
description: "Registry is the default Docker registry used for
component Docker images. If specified, all images will be pulled
from this registry. If not specified then the default registries
will be used. \n Image format: `<registry>/<imagePath>/<imageName>:<image-tag>`
will be used. A special case value, UseDefault, is supported
to explicitly specify the default registries will be used. \n
Image format: `<registry>/<imagePath>/<imageName>:<image-tag>`
\n This option allows configuring the `<registry>` portion of
the above format."
type: string
Expand Down Expand Up @@ -1143,6 +1157,11 @@ spec:
type: array
type: object
type: object
typhaMetricsPort:
description: TyphaMetricsPort specifies which port calico/typha
serves prometheus metrics on. By default, metrics are not enabled.
format: int32
type: integer
variant:
description: 'Variant is the product to install - one of Calico
or TigeraSecureEnterprise Default: Calico'
Expand Down
70 changes: 55 additions & 15 deletions reference/installation/_api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,8 @@ <h3 id="operator.tigera.io/v1.Installation">Installation
<em>(Optional)</em>
<p>Registry is the default Docker registry used for component Docker images. If specified,
all images will be pulled from this registry. If not specified then the default registries
will be used.</p>
will be used. A special case value, UseDefault, is supported to explicitly specify
the default registries will be used.</p>
<p>Image format:
<code>&lt;registry&gt;/&lt;imagePath&gt;/&lt;imageName&gt;:&lt;image-tag&gt;</code></p>
<p>This option allows configuring the <code>&lt;registry&gt;</code> portion of the above format.</p>
Expand All @@ -194,7 +195,9 @@ <h3 id="operator.tigera.io/v1.Installation">Installation
<em>(Optional)</em>
<p>ImagePath allows for the path part of an image to be specified. If specified
then the specified value will be used as the image path for each image. If not specified
or empty, the default for each image will be used.</p>
or empty, the default for each image will be used.
A special case value, UseDefault, is supported to explicitly specify the default
image path will be used for each image.</p>
<p>Image format:
<code>&lt;registry&gt;/&lt;imagePath&gt;/&lt;imageName&gt;:&lt;image-tag&gt;</code></p>
<p>This option allows configuring the <code>&lt;imagePath&gt;</code> portion of the above format.</p>
Expand Down Expand Up @@ -318,6 +321,18 @@ <h3 id="operator.tigera.io/v1.Installation">Installation
</tr>
<tr>
<td>
<code>typhaMetricsPort</code><br>
<em>
int32
</em>
</td>
<td>
<em>(Optional)</em>
<p>TyphaMetricsPort specifies which port calico/typha serves prometheus metrics on. By default, metrics are not enabled.</p>
</td>
</tr>
<tr>
<td>
<code>flexVolumePath</code><br>
<em>
string
Expand Down Expand Up @@ -356,7 +371,8 @@ <h3 id="operator.tigera.io/v1.Installation">Installation
</td>
<td>
<em>(Optional)</em>
<p>ComponentResources can be used to customize the resource requirements for each component.</p>
<p>ComponentResources can be used to customize the resource requirements for each component.
Node, Typha, and KubeControllers are supported for installations.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -471,13 +487,16 @@ <h3 id="operator.tigera.io/v1.BGPOption">BGPOption
(<em>Appears on:</em>
<a href="#operator.tigera.io/v1.CalicoNetworkSpec">CalicoNetworkSpec</a>)
</p>
<p>BGPOption describes the mode of BGP to use.</p>
<p>One of: Enabled, Disabled</p>
<h3 id="operator.tigera.io/v1.CNIPluginType">CNIPluginType
(<code>string</code> alias)</h3>
<p>
(<em>Appears on:</em>
<a href="#operator.tigera.io/v1.CNISpec">CNISpec</a>)
</p>
<p>CNIPluginType describe the type of CNI plugin used.</p>
<p>CNIPluginType describes the type of CNI plugin used.</p>
<p>One of: Calico, GKE, AmazonVPC, AzureVNET</p>
<h3 id="operator.tigera.io/v1.CNISpec">CNISpec
</h3>
<p>
Expand Down Expand Up @@ -705,7 +724,7 @@ <h3 id="operator.tigera.io/v1.CertificateManagement">CertificateManagement
<td>
<p>When a CSR is issued to the certificates.k8s.io API, the signerName is added to the request in order to accommodate for clusters
with multiple signers.
Must be formatted as: &ldquo;<my-domain>/<my-signername>&rdquo;.</p>
Must be formatted as: <code>&lt;my-domain&gt;/&lt;my-signername&gt;</code>.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -742,7 +761,8 @@ <h3 id="operator.tigera.io/v1.ComponentName">ComponentName
(<em>Appears on:</em>
<a href="#operator.tigera.io/v1.ComponentResource">ComponentResource</a>)
</p>
<p>ComponentName CRD enum</p>
<p>ComponentName represents a single component.</p>
<p>One of: Node, Typha, KubeControllers</p>
<h3 id="operator.tigera.io/v1.ComponentResource">ComponentResource
</h3>
<p>
Expand Down Expand Up @@ -806,15 +826,16 @@ <h3 id="operator.tigera.io/v1.EncapsulationType">EncapsulationType
(<em>Appears on:</em>
<a href="#operator.tigera.io/v1.IPPool">IPPool</a>)
</p>
<p>EncapsulationType is the type of encapsulation to use on an IP pool. Valid
options are: IPIP, VXLAN, IPIPCrossSubnet, VXLANCrossSubnet, None.</p>
<p>EncapsulationType is the type of encapsulation to use on an IP pool.</p>
<p>One of: IPIP, VXLAN, IPIPCrossSubnet, VXLANCrossSubnet, None</p>
<h3 id="operator.tigera.io/v1.HostPortsType">HostPortsType
(<code>string</code> alias)</h3>
<p>
(<em>Appears on:</em>
<a href="#operator.tigera.io/v1.CalicoNetworkSpec">CalicoNetworkSpec</a>)
</p>
<p>HostPortsType specifies if the HostPorts plugin enabled status.</p>
<p>HostPortsType specifies host port support.</p>
<p>One of: Enabled, Disabled</p>
<h3 id="operator.tigera.io/v1.IPAMPluginType">IPAMPluginType
(<code>string</code> alias)</h3>
<p>
Expand Down Expand Up @@ -981,8 +1002,7 @@ <h3 id="operator.tigera.io/v1.Image">Image
</td>
<td>
<p>Digest is the image identifier that will be used for the Image.
The field should not include a leading <code>@</code> and must be prefixed with <code>sha256:</code>, if other
digest prefixes are needed please submit a feature request.</p>
The field should not include a leading <code>@</code> and must be prefixed with <code>sha256:</code>.</p>
</td>
</tr>
</tbody>
Expand Down Expand Up @@ -1060,7 +1080,8 @@ <h3 id="operator.tigera.io/v1.InstallationSpec">InstallationSpec
<em>(Optional)</em>
<p>Registry is the default Docker registry used for component Docker images. If specified,
all images will be pulled from this registry. If not specified then the default registries
will be used.</p>
will be used. A special case value, UseDefault, is supported to explicitly specify
the default registries will be used.</p>
<p>Image format:
<code>&lt;registry&gt;/&lt;imagePath&gt;/&lt;imageName&gt;:&lt;image-tag&gt;</code></p>
<p>This option allows configuring the <code>&lt;registry&gt;</code> portion of the above format.</p>
Expand All @@ -1077,7 +1098,9 @@ <h3 id="operator.tigera.io/v1.InstallationSpec">InstallationSpec
<em>(Optional)</em>
<p>ImagePath allows for the path part of an image to be specified. If specified
then the specified value will be used as the image path for each image. If not specified
or empty, the default for each image will be used.</p>
or empty, the default for each image will be used.
A special case value, UseDefault, is supported to explicitly specify the default
image path will be used for each image.</p>
<p>Image format:
<code>&lt;registry&gt;/&lt;imagePath&gt;/&lt;imageName&gt;:&lt;image-tag&gt;</code></p>
<p>This option allows configuring the <code>&lt;imagePath&gt;</code> portion of the above format.</p>
Expand Down Expand Up @@ -1201,6 +1224,18 @@ <h3 id="operator.tigera.io/v1.InstallationSpec">InstallationSpec
</tr>
<tr>
<td>
<code>typhaMetricsPort</code><br>
<em>
int32
</em>
</td>
<td>
<em>(Optional)</em>
<p>TyphaMetricsPort specifies which port calico/typha serves prometheus metrics on. By default, metrics are not enabled.</p>
</td>
</tr>
<tr>
<td>
<code>flexVolumePath</code><br>
<em>
string
Expand Down Expand Up @@ -1239,7 +1274,8 @@ <h3 id="operator.tigera.io/v1.InstallationSpec">InstallationSpec
</td>
<td>
<em>(Optional)</em>
<p>ComponentResources can be used to customize the resource requirements for each component.</p>
<p>ComponentResources can be used to customize the resource requirements for each component.
Node, Typha, and KubeControllers are supported for installations.</p>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -1335,13 +1371,16 @@ <h3 id="operator.tigera.io/v1.MultiInterfaceMode">MultiInterfaceMode
(<em>Appears on:</em>
<a href="#operator.tigera.io/v1.CalicoNetworkSpec">CalicoNetworkSpec</a>)
</p>
<p>MultiInterfaceMode describes the method of providing multiple pod interfaces.</p>
<p>One of: None, Multus</p>
<h3 id="operator.tigera.io/v1.NATOutgoingType">NATOutgoingType
(<code>string</code> alias)</h3>
<p>
(<em>Appears on:</em>
<a href="#operator.tigera.io/v1.IPPool">IPPool</a>)
</p>
<p>NATOutgoingType describe the type of outgoing NAT to use.</p>
<p>One of: Enabled, Disabled</p>
<h3 id="operator.tigera.io/v1.NodeAddressAutodetection">NodeAddressAutodetection
</h3>
<p>
Expand Down Expand Up @@ -1465,7 +1504,8 @@ <h3 id="operator.tigera.io/v1.ProductVariant">ProductVariant
<a href="#operator.tigera.io/v1.InstallationSpec">InstallationSpec</a>,
<a href="#operator.tigera.io/v1.InstallationStatus">InstallationStatus</a>)
</p>
<p>ProductVariant represents the variant of the product. Valid options are: Calico, TigeraSecureEnterprise.</p>
<p>ProductVariant represents the variant of the product.</p>
<p>One of: Calico, TigeraSecureEnterprise</p>
<h3 id="operator.tigera.io/v1.Provider">Provider
(<code>string</code> alias)</h3>
<p>
Expand Down
37 changes: 20 additions & 17 deletions reference/installation/config.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,31 +6,34 @@
"ParseError$",
"List$",
"AmazonCloudIntegration",
"MetadataAccessAllowedType",
"MetadataAccessAllowedType",
"APIServer",
"Authentication",
"Auth",
"AuthMethod",
"EmailVerificationType",
"Auth",
"AuthMethod",
"EmailVerificationType",
"Compliance",
"IntrusionDetection",
"LogCollector",
"S3StoreSpec",
"SyslogStoreSpec",
"SyslogLogType",
"S3StoreSpec",
"SyslogStoreSpec",
"SyslogLogType",
"LogStorage",
"Retention",
"Nodes",
"NodeSet",
"NodeSetSelectionAttribute",
"Indices",
"AdditionalLogStoreSpec",
"AdditionalLogSourceSpec",
"EksCloudwatchLogsSpec",
"SplunkStoreSpec",
"Retention",
"Nodes",
"NodeSet",
"NodeSetSelectionAttribute",
"Indices",
"AdditionalLogStoreSpec",
"AdditionalLogSourceSpec",
"EksCloudwatchLogsSpec",
"SplunkStoreSpec",
"ManagementCluster",
"Manager",
"AuthType"
"AuthType",
"GroupSearch",
"UserMatch",
"UserSearch"
],
"externalPackages": [
{
Expand Down

0 comments on commit f2f228d

Please sign in to comment.