From d129aa43ab1c9fe8335174fd63c10353b3150f26 Mon Sep 17 00:00:00 2001 From: Soule BA Date: Mon, 12 Aug 2024 13:14:06 +0200 Subject: [PATCH] Converting html to rst crds doc Signed-off-by: Soule BA --- Makefile | 9 +- docs/customizations/crds-api.html | 2160 ----------------------------- docs/customizations/crds.rst | 1229 +++++++++++++++- hack/api-docs/config.json | 2 +- hack/api-docs/templates/pkg.tpl | 4 - 5 files changed, 1200 insertions(+), 2204 deletions(-) delete mode 100644 docs/customizations/crds-api.html diff --git a/Makefile b/Makefile index e606fae..63969f8 100644 --- a/Makefile +++ b/Makefile @@ -94,10 +94,13 @@ download-branch-api: | $(CRD_API_DEP_ROOT) curl -sL ${BRANCH_REPO_URL} \ | tar -xz -C ${CRD_API_DEP_ROOT} -.PHONY: gen-crd-api-docs -gen-crd-api-docs: | $(GEN_CRD_API_REFERENCE_DOCS) +gen-crd-api-docs: | $(GEN_CRD_API_REFERENCE_DOCS) download-branch-api cd ${CRD_API_DEP_ROOT}/network-operator-${BRANCH}/api/v1alpha1 && \ - $(GEN_CRD_API_REFERENCE_DOCS) -api-dir=. -config=${CURDIR}/hack/api-docs/config.json -template-dir=${CURDIR}/hack/api-docs/templates -out-file=${CURDIR}/docs/customizations/crds-api.html + $(GEN_CRD_API_REFERENCE_DOCS) -api-dir=. -config=${CURDIR}/hack/api-docs/config.json -template-dir=${CURDIR}/hack/api-docs/templates -out-file=${BUILDDIR}/crds-api.html + +.PHONY: api-docs +api-docs: gen-crd-api-docs + docker run --rm --volume "`pwd`:/data" --user `id -u`:`id -g` pandoc/minimal -f html -t rst -s /data/build/_output/crds-api.html -o /data/docs/customizations/crds.rst .PHONY: gen-docs gen-docs: diff --git a/docs/customizations/crds-api.html b/docs/customizations/crds-api.html deleted file mode 100644 index 82eeeb3..0000000 --- a/docs/customizations/crds-api.html +++ /dev/null @@ -1,2160 +0,0 @@ -

Network Operator API reference v1alpha1

-

Packages:

- -

mellanox.com/v1alpha1

-

Package v1alpha1 contains API Schema definitions for the mellanox.com v1alpha1 API group -API group

-Resource Types: - -

AppliedState -

-

-(Appears on: -HostDeviceNetworkStatus, -NicClusterPolicyStatus) -

-

AppliedState defines a finer-grained view of the observed state of NicClusterPolicy

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-name
- -string - -		 -
-state
- - -State - - -		 -
-message
- -string - -		 -

Message is a human readable message indicating details about why -the state is in this condition

-
-
-
-

ConfigMapNameReference -

-

-(Appears on: -OFEDDriverSpec) -

-

ConfigMapNameReference references a config map in a specific namespace. -The namespace must be specified at the point of use.

-
-
- - - - - - - - - - - - - -
FieldDescription
-name
- -string - -		 -

Name of the ConfigMap

-
-
-
-

DOCATelemetryServiceConfig -

-

-(Appears on: -DOCATelemetryServiceSpec) -

-

DOCATelemetryServiceConfig contains configuration for the DOCATelemetryService.

-
-
- - - - - - - - - - - - - -
FieldDescription
-fromConfigMap
- -string - -		 -(Optional) -

FromConfigMap sets the configMap the DOCATelemetryService gets its configuration from. The ConfigMap must be in -the same namespace as the NICClusterPolicy.

-
-
-
-

DOCATelemetryServiceSpec -

-

-(Appears on: -NicClusterPolicySpec) -

-

DOCATelemetryServiceSpec is the configuration for DOCA Telemetry Service.

-
-
- - - - - - - - - - - - - - - - - -
FieldDescription
-ImageSpec
- - -ImageSpec - - -		 -
-config
- - -DOCATelemetryServiceConfig - - -		 -(Optional) -

Config contains custom config for the DOCATelemetryService. -If set no default config will be deployed.

-
-
-
-

DevicePluginSpec -

-

-(Appears on: -NicClusterPolicySpec) -

-

DevicePluginSpec describes configuration options for device plugin -1. Image information for device plugin -2. Device plugin configuration

-
-
- - - - - - - - - - - - - - - - - -
FieldDescription
-ImageSpecWithConfig
- - -ImageSpecWithConfig - - -		 -
-useCdi
- -bool - -		 -

Enables use of container device interface (CDI)

-
-
-
-

DrainSpec -

-

-(Appears on: -DriverUpgradePolicySpec) -

-

DrainSpec describes configuration for node drain during automatic upgrade

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-enable
- -bool - -		 -(Optional) -

Enable indicates if node draining is allowed during upgrade

-
-force
- -bool - -		 -(Optional) -

Force indicates if force draining is allowed

-
-podSelector
- -string - -		 -(Optional) -

PodSelector specifies a label selector to filter pods on the node that need to be drained -For more details on label selectors, see: -https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

-
-timeoutSeconds
- -int - -		 -(Optional) -

TimeoutSecond specifies the length of time in seconds to wait before giving up drain, zero means infinite

-
-deleteEmptyDir
- -bool - -		 -(Optional) -

DeleteEmptyDir indicates if should continue even if there are pods using emptyDir -(local data that will be deleted when the node is drained)

-
-
-
-

DriverUpgradePolicySpec -

-

-(Appears on: -OFEDDriverSpec) -

-

DriverUpgradePolicySpec describes policy configuration for automatic upgrades

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-autoUpgrade
- -bool - -		 -(Optional) -

AutoUpgrade is a global switch for automatic upgrade feature -if set to false all other options are ignored

-
-maxParallelUpgrades
- -int - -		 -(Optional) -

MaxParallelUpgrades indicates how many nodes can be upgraded in parallel -0 means no limit, all nodes will be upgraded in parallel

-
-waitForCompletion
- - -WaitForCompletionSpec - - -		 -
-drain
- - -DrainSpec - - -		 -
-safeLoad
- -bool - -		 -(Optional) -

SafeLoad turn on safe driver loading (cordon and drain the node before loading the driver)

-
-
-
-

HostDeviceNetwork -

-

HostDeviceNetwork is the Schema for the hostdevicenetworks API

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -HostDeviceNetworkSpec - - -		 -
-
- - - - - - - - - - - - - -
-networkNamespace
- -string - -		 -

Namespace of the NetworkAttachmentDefinition custom resource

-
-resourceName
- -string - -		 -

Host device resource pool name

-
-ipam
- -string - -		 -

IPAM configuration to be used for this network

-
-
-status
- - -HostDeviceNetworkStatus - - -		 -
-
-
-

HostDeviceNetworkSpec -

-

-(Appears on: -HostDeviceNetwork) -

-

HostDeviceNetworkSpec defines the desired state of HostDeviceNetwork

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-networkNamespace
- -string - -		 -

Namespace of the NetworkAttachmentDefinition custom resource

-
-resourceName
- -string - -		 -

Host device resource pool name

-
-ipam
- -string - -		 -

IPAM configuration to be used for this network

-
-
-
-

HostDeviceNetworkStatus -

-

-(Appears on: -HostDeviceNetwork) -

-

HostDeviceNetworkStatus defines the observed state of HostDeviceNetwork

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-state
- - -State - - -		 -

Reflects the state of the HostDeviceNetwork

-
-hostDeviceNetworkAttachmentDef
- -string - -		 -

Network attachment definition generated from HostDeviceNetworkSpec

-
-reason
- -string - -		 -

Informative string in case the observed state is error

-
-appliedStates
- - -[]AppliedState - - -		 -

AppliedStates provide a finer view of the observed state

-
-
-
-

IBKubernetesSpec -

-

-(Appears on: -NicClusterPolicySpec) -

-

IBKubernetesSpec describes configuration options for ib-kubernetes

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-ImageSpec
- - -ImageSpec - - -		 -

Image information for ib-kubernetes

-
-periodicUpdateSeconds
- -int - -		 -(Optional) -

Interval of updates in seconds

-
-pKeyGUIDPoolRangeStart
- -string - -		 -

The first guid in the pool

-
-pKeyGUIDPoolRangeEnd
- -string - -		 -

The last guid in the pool

-
-ufmSecret
- -string - -		 -

Secret containing credentials to UFM service

-
-
-
-

IPoIBNetwork -

-

IPoIBNetwork is the Schema for the ipoibnetworks API

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -IPoIBNetworkSpec - - -		 -
-
- - - - - - - - - - - - - -
-networkNamespace
- -string - -		 -

Namespace of the NetworkAttachmentDefinition custom resource

-
-master
- -string - -		 -

Name of the host interface to enslave. Defaults to default route interface

-
-ipam
- -string - -		 -

IPAM configuration to be used for this network.

-
-
-status
- - -IPoIBNetworkStatus - - -		 -
-
-
-

IPoIBNetworkSpec -

-

-(Appears on: -IPoIBNetwork) -

-

IPoIBNetworkSpec defines the desired state of IPoIBNetwork

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-networkNamespace
- -string - -		 -

Namespace of the NetworkAttachmentDefinition custom resource

-
-master
- -string - -		 -

Name of the host interface to enslave. Defaults to default route interface

-
-ipam
- -string - -		 -

IPAM configuration to be used for this network.

-
-
-
-

IPoIBNetworkStatus -

-

-(Appears on: -IPoIBNetwork) -

-

IPoIBNetworkStatus defines the observed state of IPoIBNetwork

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-state
- - -State - - -		 -

Reflects the state of the IPoIBNetwork

-
-ipoibNetworkAttachmentDef
- -string - -		 -

Network attachment definition generated from IPoIBNetworkSpec

-
-reason
- -string - -		 -

Informative string in case the observed state is error

-
-
-
-

ImageSpec -

-

-(Appears on: -DOCATelemetryServiceSpec, -IBKubernetesSpec, -ImageSpecWithConfig, -NICFeatureDiscoverySpec, -NVIPAMSpec, -OFEDDriverSpec, -SecondaryNetworkSpec) -

-

ImageSpec Contains container image specifications

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-image
- -string - -		 -

Name of the image

-
-repository
- -string - -		 -

Address of the registry that stores the image

-
-version
- -string - -		 -

Version of the image to use

-
-imagePullSecrets
- -[]string - -		 -(Optional) -

ImagePullSecrets is an optional list of references to secrets in the same -namespace to use for pulling the image

-
-containerResources
- - -[]ResourceRequirements - - -		 -

ResourceRequirements describes the compute resource requirements

-
-
-
-

ImageSpecWithConfig -

-

-(Appears on: -DevicePluginSpec, -MultusSpec) -

-

ImageSpecWithConfig Contains ImageSpec and optional configuration

-
-
- - - - - - - - - - - - - - - - - -
FieldDescription
-ImageSpec
- - -ImageSpec - - -		 -
-config
- -string - -		 -

Configuration for the component as a string

-
-
-
-

MacvlanNetwork -

-

MacvlanNetwork is the Schema for the macvlannetworks API

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -MacvlanNetworkSpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - -
-networkNamespace
- -string - -		 -

Namespace of the NetworkAttachmentDefinition custom resource

-
-master
- -string - -		 -

Name of the host interface to enslave. Defaults to default route interface

-
-mode
- -string - -		 -

Mode of interface one of “bridge”, “private”, “vepa”, “passthru”

-
-mtu
- -int - -		 -

MTU of interface to the specified value. 0 for master’s MTU

-
-ipam
- -string - -		 -

IPAM configuration to be used for this network.

-
-
-status
- - -MacvlanNetworkStatus - - -		 -
-
-
-

MacvlanNetworkSpec -

-

-(Appears on: -MacvlanNetwork) -

-

MacvlanNetworkSpec defines the desired state of MacvlanNetwork

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-networkNamespace
- -string - -		 -

Namespace of the NetworkAttachmentDefinition custom resource

-
-master
- -string - -		 -

Name of the host interface to enslave. Defaults to default route interface

-
-mode
- -string - -		 -

Mode of interface one of “bridge”, “private”, “vepa”, “passthru”

-
-mtu
- -int - -		 -

MTU of interface to the specified value. 0 for master’s MTU

-
-ipam
- -string - -		 -

IPAM configuration to be used for this network.

-
-
-
-

MacvlanNetworkStatus -

-

-(Appears on: -MacvlanNetwork) -

-

MacvlanNetworkStatus defines the observed state of MacvlanNetwork

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-state
- - -State - - -		 -

Reflects the state of the MacvlanNetwork

-
-macvlanNetworkAttachmentDef
- -string - -		 -

Network attachment definition generated from MacvlanNetworkSpec

-
-reason
- -string - -		 -

Informative string in case the observed state is error

-
-
-
-

MultusSpec -

-

-(Appears on: -SecondaryNetworkSpec) -

-

MultusSpec describes configuration options for Multus CNI -1. Image information for Multus CNI -2. Multus CNI config if config is missing or empty then multus config will be automatically generated from the CNI -configuration file of the master plugin (the first file in lexicographical order in cni-conf-dir)

-
-
- - - - - - - - - - - - - -
FieldDescription
-ImageSpecWithConfig
- - -ImageSpecWithConfig - - -		 -
-
-
-

NICFeatureDiscoverySpec -

-

-(Appears on: -NicClusterPolicySpec) -

-

NICFeatureDiscoverySpec describes configuration options for nic-feature-discovery

-
-
- - - - - - - - - - - - - -
FieldDescription
-ImageSpec
- - -ImageSpec - - -		 -
-
-
-

NVIPAMSpec -

-

-(Appears on: -NicClusterPolicySpec) -

-

NVIPAMSpec describes configuration options for nv-ipam -1. Image information for nv-ipam -2. Configuration for nv-ipam

-
-
- - - - - - - - - - - - - - - - - -
FieldDescription
-enableWebhook
- -bool - -		 -

Enable deployment of the validation webhook

-
-ImageSpec
- - -ImageSpec - - -		 -
-
-
-

NicClusterPolicy -

-

NicClusterPolicy is the Schema for the nicclusterpolicies API

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-metadata
- - -Kubernetes meta/v1.ObjectMeta - - -		 -Refer to the Kubernetes API documentation for the fields of the -metadata field. -
-spec
- - -NicClusterPolicySpec - - -		 -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-nodeAffinity
- - -Kubernetes core/v1.NodeAffinity - - -		 -

Additional nodeAffinity rules to inject to the DaemonSets objects that are managed by the operator

-
-tolerations
- - -[]Kubernetes core/v1.Toleration - - -		 -

Additional tolerations to inject to the DaemonSets objects that are managed by the operator

-
-ofedDriver
- - -OFEDDriverSpec - - -		 -
-rdmaSharedDevicePlugin
- - -DevicePluginSpec - - -		 -
-sriovDevicePlugin
- - -DevicePluginSpec - - -		 -
-ibKubernetes
- - -IBKubernetesSpec - - -		 -
-secondaryNetwork
- - -SecondaryNetworkSpec - - -		 -
-nvIpam
- - -NVIPAMSpec - - -		 -
-nicFeatureDiscovery
- - -NICFeatureDiscoverySpec - - -		 -
-docaTelemetryService
- - -DOCATelemetryServiceSpec - - -		 -
-
-status
- - -NicClusterPolicyStatus - - -		 -
-
-
-

NicClusterPolicySpec -

-

-(Appears on: -NicClusterPolicy) -

-

NicClusterPolicySpec defines the desired state of NicClusterPolicy

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-nodeAffinity
- - -Kubernetes core/v1.NodeAffinity - - -		 -

Additional nodeAffinity rules to inject to the DaemonSets objects that are managed by the operator

-
-tolerations
- - -[]Kubernetes core/v1.Toleration - - -		 -

Additional tolerations to inject to the DaemonSets objects that are managed by the operator

-
-ofedDriver
- - -OFEDDriverSpec - - -		 -
-rdmaSharedDevicePlugin
- - -DevicePluginSpec - - -		 -
-sriovDevicePlugin
- - -DevicePluginSpec - - -		 -
-ibKubernetes
- - -IBKubernetesSpec - - -		 -
-secondaryNetwork
- - -SecondaryNetworkSpec - - -		 -
-nvIpam
- - -NVIPAMSpec - - -		 -
-nicFeatureDiscovery
- - -NICFeatureDiscoverySpec - - -		 -
-docaTelemetryService
- - -DOCATelemetryServiceSpec - - -		 -
-
-
-

NicClusterPolicyStatus -

-

-(Appears on: -NicClusterPolicy) -

-

NicClusterPolicyStatus defines the observed state of NicClusterPolicy

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-state
- - -State - - -		 -

Reflects the current state of the cluster policy

-
-reason
- -string - -		 -

Informative string in case the observed state is error

-
-appliedStates
- - -[]AppliedState - - -		 -

AppliedStates provide a finer view of the observed state

-
-
-
-

OFEDDriverSpec -

-

-(Appears on: -NicClusterPolicySpec) -

-

OFEDDriverSpec describes configuration options for OFED driver

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-ImageSpec
- - -ImageSpec - - -		 -

Image information for ofed driver container

-
-startupProbe
- - -PodProbeSpec - - -		 -

Pod startup probe settings

-
-livenessProbe
- - -PodProbeSpec - - -		 -

Pod liveness probe settings

-
-readinessProbe
- - -PodProbeSpec - - -		 -

Pod readiness probe settings

-
-env
- - -[]Kubernetes core/v1.EnvVar - - -		 -

List of environment variables to set in the OFED container.

-
-upgradePolicy
- - -DriverUpgradePolicySpec - - -		 -

Ofed auto-upgrade settings

-
-certConfig
- - -ConfigMapNameReference - - -		 -

Optional: Custom TLS certificates configuration for driver container

-
-repoConfig
- - -ConfigMapNameReference - - -		 -

Optional: Custom package repository configuration for OFED container

-
-terminationGracePeriodSeconds
- -int64 - -		 -(Optional) -

TerminationGracePeriodSeconds specifies the length of time in seconds -to wait before killing the OFED pod on termination

-
-forcePrecompiled
- -bool - -		 -(Optional) -

ForcePrecompiled specifies if only MOFED precompiled images are allowed -If set to false and precompiled image does not exists, MOFED drivers will be compiled on Nodes -If set to true and precompiled image does not exists, OFED state will be Error.

-
-
-
-

PodProbeSpec -

-

-(Appears on: -OFEDDriverSpec) -

-

PodProbeSpec describes a pod probe.

-
-
- - - - - - - - - - - - - - - - - -
FieldDescription
-initialDelaySeconds
- -int - -		 -

Number of seconds after the container has started before the probe is initiated

-
-periodSeconds
- -int - -		 -

How often (in seconds) to perform the probe

-
-
-
-

ResourceRequirements -

-

-(Appears on: -ImageSpec) -

-

ResourceRequirements describes the compute resource requirements.

-
-
- - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-name
- -string - -		 -

Name of the container the requirements are set for

-
-limits
- - -Kubernetes core/v1.ResourceList - - -		 -(Optional) -

Limits describes the maximum amount of compute resources allowed. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

-
-requests
- - -Kubernetes core/v1.ResourceList - - -		 -(Optional) -

Requests describes the minimum amount of compute resources required. -If Requests is omitted for a container, it defaults to Limits if that is explicitly specified, -otherwise to an implementation-defined value. Requests cannot exceed Limits. -More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

-
-
-
-

SecondaryNetworkSpec -

-

-(Appears on: -NicClusterPolicySpec) -

-

SecondaryNetworkSpec describes configuration options for secondary network

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - -
FieldDescription
-multus
- - -MultusSpec - - -		 -

Image and configuration information for multus

-
-cniPlugins
- - -ImageSpec - - -		 -

Image information for CNI plugins

-
-ipoib
- - -ImageSpec - - -		 -

Image information for IPoIB CNI

-
-ipamPlugin
- - -ImageSpec - - -		 -

Image information for IPAM plugin

-
-
-
-

State -(string alias)

-

-(Appears on: -AppliedState, -HostDeviceNetworkStatus, -IPoIBNetworkStatus, -MacvlanNetworkStatus, -NicClusterPolicyStatus) -

-

State represents reconcile state of the system.

-

WaitForCompletionSpec -

-

-(Appears on: -DriverUpgradePolicySpec) -

-

WaitForCompletionSpec describes the configuration for waiting on job completions

-
-
- - - - - - - - - - - - - - - - - -
FieldDescription
-podSelector
- -string - -		 -(Optional) -

PodSelector specifies a label selector for the pods to wait for completion -For more details on label selectors, see: -https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/#label-selectors

-
-timeoutSeconds
- -int - -		 -(Optional) -

TimeoutSecond specifies the length of time in seconds -to wait before giving up on pod termination, zero means infinite

-
-
-
-
-

This page was automatically generated with gen-crd-api-reference-docs

-
diff --git a/docs/customizations/crds.rst b/docs/customizations/crds.rst index d8396c6..3836942 100644 --- a/docs/customizations/crds.rst +++ b/docs/customizations/crds.rst @@ -1,51 +1,1208 @@ -.. license-header - SPDX-FileCopyrightText: Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved. - SPDX-License-Identifier: Apache-2.0 +Network Operator API reference v1alpha1 +======================================= - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at +Packages: - http://www.apache.org/licenses/LICENSE-2.0 +- `mellanox.com/v1alpha1 <#mellanox.com%2fv1alpha1>`__ - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. +.. _mellanox.com/v1alpha1: -.. headings # #, * *, =, -, ^, " +mellanox.com/v1alpha1 +--------------------- +Package v1alpha1 contains API Schema definitions for the mellanox.com +v1alpha1 API group -**** -CRDs -**** +Resource Types: -.. contents:: - :depth: 2 - :local: - :backlinks: none +.. _mellanox.com/v1alpha1.AppliedState: -==================== -NicClusterPolicy CRD -==================== +AppliedState +~~~~~~~~~~~~ -To change ``NicClusterPolicy`` CRD object manually without helm you need to change ``nic-cluster-policy`` CR like a regular Kubernetes resource. For more information on NicClusterPolicy custom resource, please refer to the `Network-Operator Project Sources `__. +(*Appears on:* +`HostDeviceNetworkStatus <#mellanox.com/v1alpha1.HostDeviceNetworkStatus>`__, +`NicClusterPolicyStatus <#mellanox.com/v1alpha1.NicClusterPolicyStatus>`__) -================== -MacVlanNetwork CRD -================== +AppliedState defines a finer-grained view of the observed state of +NicClusterPolicy -For more information on `MacVlanNetwork` custom resource, please refer to the `Network-Operator Project Sources `__. +.. container:: md-typeset__scrollwrap -===================== -HostDeviceNetwork CRD -===================== + .. container:: md-typeset__table -For more information on `HostDeviceNetwork` custom resource, please refer to the `Network-Operator Project Sources `__. + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``name`` | | + | *string* | | + +-----------------------------------+-----------------------------------+ + | ``state`` | | + | `State | | + | <#mellanox.com/v1alpha1.State>`__ | | + +-----------------------------------+-----------------------------------+ + | ``message`` | Message is a human readable | + | *string* | message indicating details about | + | | why the state is in this | + | | condition | + +-----------------------------------+-----------------------------------+ -================ -IPoIBNetwork CRD -================ +.. _mellanox.com/v1alpha1.ConfigMapNameReference: -For more information on `IPoIBNetwork` custom resource, please refer to the `Network-Operator Project Sources `__. +ConfigMapNameReference +~~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`OFEDDriverSpec <#mellanox.com/v1alpha1.OFEDDriverSpec>`__) + +ConfigMapNameReference references a config map in a specific namespace. +The namespace must be specified at the point of use. + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``name`` | Name of the ConfigMap | + | *string* | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.DOCATelemetryServiceConfig: + +DOCATelemetryServiceConfig +~~~~~~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`DOCATelemetryServiceSpec <#mellanox.com/v1alpha1.DOCATelemetryServiceSpec>`__) + +DOCATelemetryServiceConfig contains configuration for the +DOCATelemetryService. + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``fromConfigMap`` | *(Optional)* | + | *string* | FromConfigMap sets the configMap | + | | the DOCATelemetryService gets its | + | | configuration from. The ConfigMap | + | | must be in the same namespace as | + | | the NICClusterPolicy. | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.DOCATelemetryServiceSpec: + +DOCATelemetryServiceSpec +~~~~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`NicClusterPolicySpec <#mellanox.com/v1alpha1.NicClusterPolicySpec>`__) + +DOCATelemetryServiceSpec is the configuration for DOCA Telemetry +Service. + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``ImageSpec`` | | + | `ImageSpec <#me | | + | llanox.com/v1alpha1.ImageSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``config`` | *(Optional)* | + | `DOCATelemetrySe | Config contains custom config for | + | rviceConfig <#mellanox.com/v1alph | the DOCATelemetryService. If set | + | a1.DOCATelemetryServiceConfig>`__ | no default config will be | + | | deployed. | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.DevicePluginSpec: + +DevicePluginSpec +~~~~~~~~~~~~~~~~ + +(*Appears on:* +`NicClusterPolicySpec <#mellanox.com/v1alpha1.NicClusterPolicySpec>`__) + +DevicePluginSpec describes configuration options for device plugin 1. +Image information for device plugin 2. Device plugin configuration + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``ImageSpecWithConfig`` | | + | `I | | + | mageSpecWithConfig <#mellanox.com | | + | /v1alpha1.ImageSpecWithConfig>`__ | | + +-----------------------------------+-----------------------------------+ + | ``useCdi`` | Enables use of container device | + | *bool* | interface (CDI) | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.DrainSpec: + +DrainSpec +~~~~~~~~~ + +(*Appears on:* +`DriverUpgradePolicySpec <#mellanox.com/v1alpha1.DriverUpgradePolicySpec>`__) + +DrainSpec describes configuration for node drain during automatic +upgrade + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``enable`` | *(Optional)* | + | *bool* | Enable indicates if node draining | + | | is allowed during upgrade | + +-----------------------------------+-----------------------------------+ + | ``force`` | *(Optional)* | + | *bool* | Force indicates if force draining | + | | is allowed | + +-----------------------------------+-----------------------------------+ + | ``podSelector`` | *(Optional)* | + | *string* | PodSelector specifies a label | + | | selector to filter pods on the | + | | node that need to be drained For | + | | more details on label selectors, | + | | see: | + | | https://kubernetes.io/d | + | | ocs/concepts/overview/working-wit | + | | h-objects/labels/#label-selectors | + +-----------------------------------+-----------------------------------+ + | ``timeoutSeconds`` | *(Optional)* | + | *int* | TimeoutSecond specifies the | + | | length of time in seconds to wait | + | | before giving up drain, zero | + | | means infinite | + +-----------------------------------+-----------------------------------+ + | ``deleteEmptyDir`` | *(Optional)* | + | *bool* | DeleteEmptyDir indicates if | + | | should continue even if there are | + | | pods using emptyDir (local data | + | | that will be deleted when the | + | | node is drained) | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.DriverUpgradePolicySpec: + +DriverUpgradePolicySpec +~~~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`OFEDDriverSpec <#mellanox.com/v1alpha1.OFEDDriverSpec>`__) + +DriverUpgradePolicySpec describes policy configuration for automatic +upgrades + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``autoUpgrade`` | *(Optional)* | + | *bool* | AutoUpgrade is a global switch | + | | for automatic upgrade feature if | + | | set to false all other options | + | | are ignored | + +-----------------------------------+-----------------------------------+ + | ``maxParallelUpgrades`` | *(Optional)* | + | *int* | MaxParallelUpgrades indicates how | + | | many nodes can be upgraded in | + | | parallel 0 means no limit, all | + | | nodes will be upgraded in | + | | parallel | + +-----------------------------------+-----------------------------------+ + | ``waitForCompletion`` | | + | `WaitF | | + | orCompletionSpec <#mellanox.com/v | | + | 1alpha1.WaitForCompletionSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``drain`` | | + | `DrainSpec <#me | | + | llanox.com/v1alpha1.DrainSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``safeLoad`` | *(Optional)* | + | *bool* | SafeLoad turn on safe driver | + | | loading (cordon and drain the | + | | node before loading the driver) | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.HostDeviceNetwork: + +HostDeviceNetwork +~~~~~~~~~~~~~~~~~ + +HostDeviceNetwork is the Schema for the hostdevicenetworks API + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``metadata`` | Refer to the Kubernetes API | + | `Kubernetes | documentation for the fields of | + | meta/v1.ObjectMeta `__ | | + +-----------------------------------+-----------------------------------+ + | ``spec`` | +--------------+--------------+ | + | `HostD | | ``networ | Namespace of | | + | eviceNetworkSpec <#mellanox.com/v | | kNamespace`` | the | | + | 1alpha1.HostDeviceNetworkSpec>`__ | | *string* | Net | | + | | | | workAttachme | | + | | | | ntDefinition | | + | | | | custom | | + | | | | resource | | + | | +--------------+--------------+ | + | | | ``re | Host device | | + | | | sourceName`` | resource | | + | | | *string* | pool name | | + | | +--------------+--------------+ | + | | | ``ipam`` | IPAM | | + | | | *string* | c | | + | | | | onfiguration | | + | | | | to be used | | + | | | | for this | | + | | | | network | | + | | +--------------+--------------+ | + +-----------------------------------+-----------------------------------+ + | ``status`` | | + | `HostDevic | | + | eNetworkStatus <#mellanox.com/v1a | | + | lpha1.HostDeviceNetworkStatus>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.HostDeviceNetworkSpec: + +HostDeviceNetworkSpec +~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`HostDeviceNetwork <#mellanox.com/v1alpha1.HostDeviceNetwork>`__) + +HostDeviceNetworkSpec defines the desired state of HostDeviceNetwork + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``networkNamespace`` | Namespace of the | + | *string* | NetworkAttachmentDefinition | + | | custom resource | + +-----------------------------------+-----------------------------------+ + | ``resourceName`` | Host device resource pool name | + | *string* | | + +-----------------------------------+-----------------------------------+ + | ``ipam`` | IPAM configuration to be used for | + | *string* | this network | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.HostDeviceNetworkStatus: + +HostDeviceNetworkStatus +~~~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`HostDeviceNetwork <#mellanox.com/v1alpha1.HostDeviceNetwork>`__) + +HostDeviceNetworkStatus defines the observed state of HostDeviceNetwork + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``state`` | Reflects the state of the | + | `State | HostDeviceNetwork | + | <#mellanox.com/v1alpha1.State>`__ | | + +-----------------------------------+-----------------------------------+ + | ` | Network attachment definition | + | `hostDeviceNetworkAttachmentDef`` | generated from | + | *string* | HostDeviceNetworkSpec | + +-----------------------------------+-----------------------------------+ + | ``reason`` | Informative string in case the | + | *string* | observed state is error | + +-----------------------------------+-----------------------------------+ + | ``appliedStates`` | AppliedStates provide a finer | + | `[]AppliedState <#mella | view of the observed state | + | nox.com/v1alpha1.AppliedState>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.IBKubernetesSpec: + +IBKubernetesSpec +~~~~~~~~~~~~~~~~ + +(*Appears on:* +`NicClusterPolicySpec <#mellanox.com/v1alpha1.NicClusterPolicySpec>`__) + +IBKubernetesSpec describes configuration options for ib-kubernetes + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``ImageSpec`` | Image information for | + | `ImageSpec <#me | ib-kubernetes | + | llanox.com/v1alpha1.ImageSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``periodicUpdateSeconds`` | *(Optional)* | + | *int* | Interval of updates in seconds | + +-----------------------------------+-----------------------------------+ + | ``pKeyGUIDPoolRangeStart`` | The first guid in the pool | + | *string* | | + +-----------------------------------+-----------------------------------+ + | ``pKeyGUIDPoolRangeEnd`` | The last guid in the pool | + | *string* | | + +-----------------------------------+-----------------------------------+ + | ``ufmSecret`` | Secret containing credentials to | + | *string* | UFM service | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.IPoIBNetwork: + +IPoIBNetwork +~~~~~~~~~~~~ + +IPoIBNetwork is the Schema for the ipoibnetworks API + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``metadata`` | Refer to the Kubernetes API | + | `Kubernetes | documentation for the fields of | + | meta/v1.ObjectMeta `__ | | + +-----------------------------------+-----------------------------------+ + | ``spec`` | +--------------+--------------+ | + | `IPoIBNetworkSpec <#mellanox. | | ``networ | Namespace of | | + | com/v1alpha1.IPoIBNetworkSpec>`__ | | kNamespace`` | the | | + | | | *string* | Net | | + | | | | workAttachme | | + | | | | ntDefinition | | + | | | | custom | | + | | | | resource | | + | | +--------------+--------------+ | + | | | ``master`` | Name of the | | + | | | *string* | host | | + | | | | interface to | | + | | | | enslave. | | + | | | | Defaults to | | + | | | | default | | + | | | | route | | + | | | | interface | | + | | +--------------+--------------+ | + | | | ``ipam`` | IPAM | | + | | | *string* | c | | + | | | | onfiguration | | + | | | | to be used | | + | | | | for this | | + | | | | network. | | + | | +--------------+--------------+ | + +-----------------------------------+-----------------------------------+ + | ``status`` | | + | `IPoIBNetworkStatus <#mellanox.co | | + | m/v1alpha1.IPoIBNetworkStatus>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.IPoIBNetworkSpec: + +IPoIBNetworkSpec +~~~~~~~~~~~~~~~~ + +(*Appears on:* `IPoIBNetwork <#mellanox.com/v1alpha1.IPoIBNetwork>`__) + +IPoIBNetworkSpec defines the desired state of IPoIBNetwork + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``networkNamespace`` | Namespace of the | + | *string* | NetworkAttachmentDefinition | + | | custom resource | + +-----------------------------------+-----------------------------------+ + | ``master`` | Name of the host interface to | + | *string* | enslave. Defaults to default | + | | route interface | + +-----------------------------------+-----------------------------------+ + | ``ipam`` | IPAM configuration to be used for | + | *string* | this network. | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.IPoIBNetworkStatus: + +IPoIBNetworkStatus +~~~~~~~~~~~~~~~~~~ + +(*Appears on:* `IPoIBNetwork <#mellanox.com/v1alpha1.IPoIBNetwork>`__) + +IPoIBNetworkStatus defines the observed state of IPoIBNetwork + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``state`` | Reflects the state of the | + | `State | IPoIBNetwork | + | <#mellanox.com/v1alpha1.State>`__ | | + +-----------------------------------+-----------------------------------+ + | ``ipoibNetworkAttachmentDef`` | Network attachment definition | + | *string* | generated from IPoIBNetworkSpec | + +-----------------------------------+-----------------------------------+ + | ``reason`` | Informative string in case the | + | *string* | observed state is error | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.ImageSpec: + +ImageSpec +~~~~~~~~~ + +(*Appears on:* +`DOCATelemetryServiceSpec <#mellanox.com/v1alpha1.DOCATelemetryServiceSpec>`__, +`IBKubernetesSpec <#mellanox.com/v1alpha1.IBKubernetesSpec>`__, +`ImageSpecWithConfig <#mellanox.com/v1alpha1.ImageSpecWithConfig>`__, +`NICFeatureDiscoverySpec <#mellanox.com/v1alpha1.NICFeatureDiscoverySpec>`__, +`NVIPAMSpec <#mellanox.com/v1alpha1.NVIPAMSpec>`__, +`OFEDDriverSpec <#mellanox.com/v1alpha1.OFEDDriverSpec>`__, +`SecondaryNetworkSpec <#mellanox.com/v1alpha1.SecondaryNetworkSpec>`__) + +ImageSpec Contains container image specifications + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``image`` | Name of the image | + | *string* | | + +-----------------------------------+-----------------------------------+ + | ``repository`` | Address of the registry that | + | *string* | stores the image | + +-----------------------------------+-----------------------------------+ + | ``version`` | Version of the image to use | + | *string* | | + +-----------------------------------+-----------------------------------+ + | ``imagePullSecrets`` | *(Optional)* | + | *[]string* | ImagePullSecrets is an optional | + | | list of references to secrets in | + | | the same namespace to use for | + | | pulling the image | + +-----------------------------------+-----------------------------------+ + | ``containerResources`` | ResourceRequirements describes | + | `[]Res | the compute resource requirements | + | ourceRequirements <#mellanox.com/ | | + | v1alpha1.ResourceRequirements>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.ImageSpecWithConfig: + +ImageSpecWithConfig +~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`DevicePluginSpec <#mellanox.com/v1alpha1.DevicePluginSpec>`__, +`MultusSpec <#mellanox.com/v1alpha1.MultusSpec>`__) + +ImageSpecWithConfig Contains ImageSpec and optional configuration + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``ImageSpec`` | | + | `ImageSpec <#me | | + | llanox.com/v1alpha1.ImageSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``config`` | Configuration for the component | + | *string* | as a string | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.MacvlanNetwork: + +MacvlanNetwork +~~~~~~~~~~~~~~ + +MacvlanNetwork is the Schema for the macvlannetworks API + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``metadata`` | Refer to the Kubernetes API | + | `Kubernetes | documentation for the fields of | + | meta/v1.ObjectMeta `__ | | + +-----------------------------------+-----------------------------------+ + | ``spec`` | +--------------+--------------+ | + | `MacvlanNetworkSpec <#mellanox.co | | ``networ | Namespace of | | + | m/v1alpha1.MacvlanNetworkSpec>`__ | | kNamespace`` | the | | + | | | *string* | Net | | + | | | | workAttachme | | + | | | | ntDefinition | | + | | | | custom | | + | | | | resource | | + | | +--------------+--------------+ | + | | | ``master`` | Name of the | | + | | | *string* | host | | + | | | | interface to | | + | | | | enslave. | | + | | | | Defaults to | | + | | | | default | | + | | | | route | | + | | | | interface | | + | | +--------------+--------------+ | + | | | ``mode`` | Mode of | | + | | | *string* | interface | | + | | | | one of | | + | | | | “bridge”, | | + | | | | “private”, | | + | | | | “vepa”, | | + | | | | “passthru” | | + | | +--------------+--------------+ | + | | | ``mtu`` | MTU of | | + | | | *int* | interface to | | + | | | | the | | + | | | | specified | | + | | | | value. 0 for | | + | | | | master’s MTU | | + | | +--------------+--------------+ | + | | | ``ipam`` | IPAM | | + | | | *string* | c | | + | | | | onfiguration | | + | | | | to be used | | + | | | | for this | | + | | | | network. | | + | | +--------------+--------------+ | + +-----------------------------------+-----------------------------------+ + | ``status`` | | + | `Mac | | + | vlanNetworkStatus <#mellanox.com/ | | + | v1alpha1.MacvlanNetworkStatus>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.MacvlanNetworkSpec: + +MacvlanNetworkSpec +~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`MacvlanNetwork <#mellanox.com/v1alpha1.MacvlanNetwork>`__) + +MacvlanNetworkSpec defines the desired state of MacvlanNetwork + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``networkNamespace`` | Namespace of the | + | *string* | NetworkAttachmentDefinition | + | | custom resource | + +-----------------------------------+-----------------------------------+ + | ``master`` | Name of the host interface to | + | *string* | enslave. Defaults to default | + | | route interface | + +-----------------------------------+-----------------------------------+ + | ``mode`` | Mode of interface one of | + | *string* | “bridge”, “private”, “vepa”, | + | | “passthru” | + +-----------------------------------+-----------------------------------+ + | ``mtu`` | MTU of interface to the specified | + | *int* | value. 0 for master’s MTU | + +-----------------------------------+-----------------------------------+ + | ``ipam`` | IPAM configuration to be used for | + | *string* | this network. | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.MacvlanNetworkStatus: + +MacvlanNetworkStatus +~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`MacvlanNetwork <#mellanox.com/v1alpha1.MacvlanNetwork>`__) + +MacvlanNetworkStatus defines the observed state of MacvlanNetwork + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``state`` | Reflects the state of the | + | `State | MacvlanNetwork | + | <#mellanox.com/v1alpha1.State>`__ | | + +-----------------------------------+-----------------------------------+ + | ``macvlanNetworkAttachmentDef`` | Network attachment definition | + | *string* | generated from MacvlanNetworkSpec | + +-----------------------------------+-----------------------------------+ + | ``reason`` | Informative string in case the | + | *string* | observed state is error | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.MultusSpec: + +MultusSpec +~~~~~~~~~~ + +(*Appears on:* +`SecondaryNetworkSpec <#mellanox.com/v1alpha1.SecondaryNetworkSpec>`__) + +MultusSpec describes configuration options for Multus CNI 1. Image +information for Multus CNI 2. Multus CNI config if config is missing or +empty then multus config will be automatically generated from the CNI +configuration file of the master plugin (the first file in +lexicographical order in cni-conf-dir) + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``ImageSpecWithConfig`` | | + | `I | | + | mageSpecWithConfig <#mellanox.com | | + | /v1alpha1.ImageSpecWithConfig>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.NICFeatureDiscoverySpec: + +NICFeatureDiscoverySpec +~~~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`NicClusterPolicySpec <#mellanox.com/v1alpha1.NicClusterPolicySpec>`__) + +NICFeatureDiscoverySpec describes configuration options for +nic-feature-discovery + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``ImageSpec`` | | + | `ImageSpec <#me | | + | llanox.com/v1alpha1.ImageSpec>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.NVIPAMSpec: + +NVIPAMSpec +~~~~~~~~~~ + +(*Appears on:* +`NicClusterPolicySpec <#mellanox.com/v1alpha1.NicClusterPolicySpec>`__) + +NVIPAMSpec describes configuration options for nv-ipam 1. Image +information for nv-ipam 2. Configuration for nv-ipam + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``enableWebhook`` | Enable deployment of the | + | *bool* | validation webhook | + +-----------------------------------+-----------------------------------+ + | ``ImageSpec`` | | + | `ImageSpec <#me | | + | llanox.com/v1alpha1.ImageSpec>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.NicClusterPolicy: + +NicClusterPolicy +~~~~~~~~~~~~~~~~ + +NicClusterPolicy is the Schema for the nicclusterpolicies API + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``metadata`` | Refer to the Kubernetes API | + | `Kubernetes | documentation for the fields of | + | meta/v1.ObjectMeta `__ | | + +-----------------------------------+-----------------------------------+ + | ``spec`` | +--------------+--------------+ | + | `Nic | | ``no | Additional | | + | ClusterPolicySpec <#mellanox.com/ | | deAffinity`` | nodeAffinity | | + | v1alpha1.NicClusterPolicySpec>`__ | | `Kubernetes | rules to | | + | | | cor | inject to | | + | | | e/v1.NodeAff | the | | + | | | inity `__ | operator | | + | | +--------------+--------------+ | + | | | ``t | Additional | | + | | | olerations`` | tolerations | | + | | | ` | to inject to | | + | | | []Kubernetes | the | | + | | | core/v1.Tol | DaemonSets | | + | | | eration `__ | | | + | | +--------------+--------------+ | + | | | `` | | | + | | | ofedDriver`` | | | + | | | `OFEDDrive | | | + | | | rSpec <#mell | | | + | | | anox.com/v1a | | | + | | | lpha1.OFEDDr | | | + | | | iverSpec>`__ | | | + | | +--------------+--------------+ | + | | | `` | | | + | | | rdmaSharedDe | | | + | | | vicePlugin`` | | | + | | | `D | | | + | | | evicePluginS | | | + | | | pec <#mellan | | | + | | | ox.com/v1alp | | | + | | | ha1.DevicePl | | | + | | | uginSpec>`__ | | | + | | +--------------+--------------+ | + | | | ``sriovDe | | | + | | | vicePlugin`` | | | + | | | `D | | | + | | | evicePluginS | | | + | | | pec <#mellan | | | + | | | ox.com/v1alp | | | + | | | ha1.DevicePl | | | + | | | uginSpec>`__ | | | + | | +--------------+--------------+ | + | | | ``ib | | | + | | | Kubernetes`` | | | + | | | `I | | | + | | | BKubernetesS | | | + | | | pec <#mellan | | | + | | | ox.com/v1alp | | | + | | | ha1.IBKubern | | | + | | | etesSpec>`__ | | | + | | +--------------+--------------+ | + | | | ``second | | | + | | | aryNetwork`` | | | + | | | `Secondary | | | + | | | NetworkSpec | | | + | | | <#mellanox.c | | | + | | | om/v1alpha1. | | | + | | | SecondaryNet | | | + | | | workSpec>`__ | | | + | | +--------------+--------------+ | + | | | ``nvIpam`` | | | + | | | `N | | | + | | | VIPAMSpec <# | | | + | | | mellanox.com | | | + | | | /v1alpha1.NV | | | + | | | IPAMSpec>`__ | | | + | | +--------------+--------------+ | + | | | ``nicFeatur | | | + | | | eDiscovery`` | | | + | | | `NIC | | | + | | | FeatureDisco | | | + | | | verySpec <#m | | | + | | | ellanox.com/ | | | + | | | v1alpha1.NIC | | | + | | | FeatureDisco | | | + | | | verySpec>`__ | | | + | | +--------------+--------------+ | + | | | ``docaTeleme | | | + | | | tryService`` | | | + | | | `DOCAT | | | + | | | elemetryServ | | | + | | | iceSpec <#me | | | + | | | llanox.com/v | | | + | | | 1alpha1.DOCA | | | + | | | TelemetrySer | | | + | | | viceSpec>`__ | | | + | | +--------------+--------------+ | + +-----------------------------------+-----------------------------------+ + | ``status`` | | + | `NicClus | | + | terPolicyStatus <#mellanox.com/v1 | | + | alpha1.NicClusterPolicyStatus>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.NicClusterPolicySpec: + +NicClusterPolicySpec +~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`NicClusterPolicy <#mellanox.com/v1alpha1.NicClusterPolicy>`__) + +NicClusterPolicySpec defines the desired state of NicClusterPolicy + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``nodeAffinity`` | Additional nodeAffinity rules to | + | `Kubernetes | inject to the DaemonSets objects | + | core/v1.N | that are managed by the operator | + | odeAffinity `__ | | + +-----------------------------------+-----------------------------------+ + | ``tolerations`` | Additional tolerations to inject | + | `[]Kubernetes | to the DaemonSets objects that | + | core/ | are managed by the operator | + | v1.Toleration `__ | | + +-----------------------------------+-----------------------------------+ + | ``ofedDriver`` | | + | `OFEDDriverSpec <#mellano | | + | x.com/v1alpha1.OFEDDriverSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``rdmaSharedDevicePlugin`` | | + | `DevicePluginSpec <#mellanox. | | + | com/v1alpha1.DevicePluginSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``sriovDevicePlugin`` | | + | `DevicePluginSpec <#mellanox. | | + | com/v1alpha1.DevicePluginSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``ibKubernetes`` | | + | `IBKubernetesSpec <#mellanox. | | + | com/v1alpha1.IBKubernetesSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``secondaryNetwork`` | | + | `Sec | | + | ondaryNetworkSpec <#mellanox.com/ | | + | v1alpha1.SecondaryNetworkSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``nvIpam`` | | + | `NVIPAMSpec <#mel | | + | lanox.com/v1alpha1.NVIPAMSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``nicFeatureDiscovery`` | | + | `NICFeatur | | + | eDiscoverySpec <#mellanox.com/v1a | | + | lpha1.NICFeatureDiscoverySpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``docaTelemetryService`` | | + | `DOCATelemet | | + | ryServiceSpec <#mellanox.com/v1al | | + | pha1.DOCATelemetryServiceSpec>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.NicClusterPolicyStatus: + +NicClusterPolicyStatus +~~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`NicClusterPolicy <#mellanox.com/v1alpha1.NicClusterPolicy>`__) + +NicClusterPolicyStatus defines the observed state of NicClusterPolicy + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``state`` | Reflects the current state of the | + | `State | cluster policy | + | <#mellanox.com/v1alpha1.State>`__ | | + +-----------------------------------+-----------------------------------+ + | ``reason`` | Informative string in case the | + | *string* | observed state is error | + +-----------------------------------+-----------------------------------+ + | ``appliedStates`` | AppliedStates provide a finer | + | `[]AppliedState <#mella | view of the observed state | + | nox.com/v1alpha1.AppliedState>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.OFEDDriverSpec: + +OFEDDriverSpec +~~~~~~~~~~~~~~ + +(*Appears on:* +`NicClusterPolicySpec <#mellanox.com/v1alpha1.NicClusterPolicySpec>`__) + +OFEDDriverSpec describes configuration options for OFED driver + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``ImageSpec`` | Image information for ofed driver | + | `ImageSpec <#me | container | + | llanox.com/v1alpha1.ImageSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``startupProbe`` | Pod startup probe settings | + | `PodProbeSpec <#mella | | + | nox.com/v1alpha1.PodProbeSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``livenessProbe`` | Pod liveness probe settings | + | `PodProbeSpec <#mella | | + | nox.com/v1alpha1.PodProbeSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``readinessProbe`` | Pod readiness probe settings | + | `PodProbeSpec <#mella | | + | nox.com/v1alpha1.PodProbeSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``env`` | List of environment variables to | + | `[]Kubernetes | set in the OFED container. | + | core/v1.EnvVar `__ | | + +-----------------------------------+-----------------------------------+ + | ``upgradePolicy`` | Ofed auto-upgrade settings | + | `DriverUpg | | + | radePolicySpec <#mellanox.com/v1a | | + | lpha1.DriverUpgradePolicySpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``certConfig`` | Optional: Custom TLS certificates | + | `ConfigM | configuration for driver | + | apNameReference <#mellanox.com/v1 | container | + | alpha1.ConfigMapNameReference>`__ | | + +-----------------------------------+-----------------------------------+ + | ``repoConfig`` | Optional: Custom package | + | `ConfigM | repository configuration for OFED | + | apNameReference <#mellanox.com/v1 | container | + | alpha1.ConfigMapNameReference>`__ | | + +-----------------------------------+-----------------------------------+ + | ``terminationGracePeriodSeconds`` | *(Optional)* | + | *int64* | TerminationGracePeriodSeconds | + | | specifies the length of time in | + | | seconds to wait before killing | + | | the OFED pod on termination | + +-----------------------------------+-----------------------------------+ + | ``forcePrecompiled`` | *(Optional)* | + | *bool* | ForcePrecompiled specifies if | + | | only MOFED precompiled images are | + | | allowed If set to false and | + | | precompiled image does not | + | | exists, MOFED drivers will be | + | | compiled on Nodes If set to true | + | | and precompiled image does not | + | | exists, OFED state will be Error. | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.PodProbeSpec: + +PodProbeSpec +~~~~~~~~~~~~ + +(*Appears on:* +`OFEDDriverSpec <#mellanox.com/v1alpha1.OFEDDriverSpec>`__) + +PodProbeSpec describes a pod probe. + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``initialDelaySeconds`` | Number of seconds after the | + | *int* | container has started before the | + | | probe is initiated | + +-----------------------------------+-----------------------------------+ + | ``periodSeconds`` | How often (in seconds) to perform | + | *int* | the probe | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.ResourceRequirements: + +ResourceRequirements +~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* `ImageSpec <#mellanox.com/v1alpha1.ImageSpec>`__) + +ResourceRequirements describes the compute resource requirements. + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``name`` | Name of the container the | + | *string* | requirements are set for | + +-----------------------------------+-----------------------------------+ + | ``limits`` | *(Optional)* | + | `Kubernetes | Limits describes the maximum | + | core/v1.R | amount of compute resources | + | esourceList `__ | https://kube | + | | rnetes.io/docs/concepts/configura | + | | tion/manage-resources-containers/ | + +-----------------------------------+-----------------------------------+ + | ``requests`` | *(Optional)* | + | `Kubernetes | Requests describes the minimum | + | core/v1.R | amount of compute resources | + | esourceList `__ | for a container, it defaults to | + | | Limits if that is explicitly | + | | specified, otherwise to an | + | | implementation-defined value. | + | | Requests cannot exceed Limits. | + | | More info: | + | | https://kube | + | | rnetes.io/docs/concepts/configura | + | | tion/manage-resources-containers/ | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.SecondaryNetworkSpec: + +SecondaryNetworkSpec +~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`NicClusterPolicySpec <#mellanox.com/v1alpha1.NicClusterPolicySpec>`__) + +SecondaryNetworkSpec describes configuration options for secondary +network + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``multus`` | Image and configuration | + | `MultusSpec <#mel | information for multus | + | lanox.com/v1alpha1.MultusSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``cniPlugins`` | Image information for CNI plugins | + | `ImageSpec <#me | | + | llanox.com/v1alpha1.ImageSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``ipoib`` | Image information for IPoIB CNI | + | `ImageSpec <#me | | + | llanox.com/v1alpha1.ImageSpec>`__ | | + +-----------------------------------+-----------------------------------+ + | ``ipamPlugin`` | Image information for IPAM plugin | + | `ImageSpec <#me | | + | llanox.com/v1alpha1.ImageSpec>`__ | | + +-----------------------------------+-----------------------------------+ + +.. _mellanox.com/v1alpha1.State: + +State (``string`` alias) +~~~~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* `AppliedState <#mellanox.com/v1alpha1.AppliedState>`__, +`HostDeviceNetworkStatus <#mellanox.com/v1alpha1.HostDeviceNetworkStatus>`__, +`IPoIBNetworkStatus <#mellanox.com/v1alpha1.IPoIBNetworkStatus>`__, +`MacvlanNetworkStatus <#mellanox.com/v1alpha1.MacvlanNetworkStatus>`__, +`NicClusterPolicyStatus <#mellanox.com/v1alpha1.NicClusterPolicyStatus>`__) + +State represents reconcile state of the system. + +.. _mellanox.com/v1alpha1.WaitForCompletionSpec: + +WaitForCompletionSpec +~~~~~~~~~~~~~~~~~~~~~ + +(*Appears on:* +`DriverUpgradePolicySpec <#mellanox.com/v1alpha1.DriverUpgradePolicySpec>`__) + +WaitForCompletionSpec describes the configuration for waiting on job +completions + +.. container:: md-typeset__scrollwrap + + .. container:: md-typeset__table + + +-----------------------------------+-----------------------------------+ + | Field | Description | + +===================================+===================================+ + | ``podSelector`` | *(Optional)* | + | *string* | PodSelector specifies a label | + | | selector for the pods to wait for | + | | completion For more details on | + | | label selectors, see: | + | | https://kubernetes.io/d | + | | ocs/concepts/overview/working-wit | + | | h-objects/labels/#label-selectors | + +-----------------------------------+-----------------------------------+ + | ``timeoutSeconds`` | *(Optional)* | + | *int* | TimeoutSecond specifies the | + | | length of time in seconds to wait | + | | before giving up on pod | + | | termination, zero means infinite | + +-----------------------------------+-----------------------------------+ diff --git a/hack/api-docs/config.json b/hack/api-docs/config.json index 6787d8e..6755f6c 100644 --- a/hack/api-docs/config.json +++ b/hack/api-docs/config.json @@ -25,7 +25,7 @@ }, { "typeMatchPrefix": "^k8s\\.io/(api|apimachinery/pkg/apis)/", - "docsURLTemplate": "https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" + "docsURLTemplate": "https://kubernetes.io/docs/reference/kubernetes-api//#{{lower .TypeIdentifier}}-{{arrIndex .PackageSegments -1}}-{{arrIndex .PackageSegments -2}}" } ], "typeDisplayNamePrefixOverrides": { diff --git a/hack/api-docs/templates/pkg.tpl b/hack/api-docs/templates/pkg.tpl index e06d105..fd7ee41 100644 --- a/hack/api-docs/templates/pkg.tpl +++ b/hack/api-docs/templates/pkg.tpl @@ -44,8 +44,4 @@ {{ template "type" . }} {{ end }} {{ end }} - -
-

This page was automatically generated with gen-crd-api-reference-docs

-
{{ end }}