diff --git a/docs/content/reference/api.md b/docs/content/reference/api.md index 7f1aa5a..b72b823 100644 --- a/docs/content/reference/api.md +++ b/docs/content/reference/api.md @@ -85,9 +85,11 @@ DataStoreSpec defines the desired state of DataStore. driver - string + enum The driver to use to connect to the shared datastore.
+
+ Enum: etcd, MySQL, PostgreSQL
true @@ -997,6 +999,13 @@ Defining the options for the deployed Tenant Control Plane as Deployment resourc Resources defines the amount of memory and CPU to allocate to each component of the Control Plane (kube-apiserver, controller-manager, and scheduler).
false + + runtimeClassName + string + + RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used to run the Tenant Control Plane pod. If no RuntimeClass resource matches the named class, the pod will not be run. If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an empty definition that uses the default runtime handler. More info: https://git.k8s.io/enhancements/keps/sig-node/585-runtime-class
+ + false tolerations []object @@ -2382,21 +2391,21 @@ Resources defines the amount of memory and CPU to allocate to each component of apiServer object - ResourceRequirements describes the compute resource requirements.
+ ComponentResourceRequirements describes the compute resource requirements.
false controllerManager object - ResourceRequirements describes the compute resource requirements.
+ ComponentResourceRequirements describes the compute resource requirements.
false scheduler object - ResourceRequirements describes the compute resource requirements.
+ ComponentResourceRequirements describes the compute resource requirements.
false @@ -2407,7 +2416,7 @@ Resources defines the amount of memory and CPU to allocate to each component of -ResourceRequirements describes the compute resource requirements. +ComponentResourceRequirements describes the compute resource requirements. @@ -2440,7 +2449,7 @@ ResourceRequirements describes the compute resource requirements. -ResourceRequirements describes the compute resource requirements. +ComponentResourceRequirements describes the compute resource requirements.
@@ -2473,7 +2482,7 @@ ResourceRequirements describes the compute resource requirements. -ResourceRequirements describes the compute resource requirements. +ComponentResourceRequirements describes the compute resource requirements.
@@ -2626,7 +2635,7 @@ TopologySpreadConstraint specifies how to spread matching pods among the given t @@ -2634,7 +2643,7 @@ TopologySpreadConstraint specifies how to spread matching pods among the given t @@ -2946,16 +2955,51 @@ Enables the Konnectivity addon in the Tenant Cluster, required if the worker nod - - + + - + - + + + + + +
string NodeAffinityPolicy indicates how we will treat Pod's nodeAffinity/nodeSelector when calculating pod topology spread skew. Options are: - Honor: only nodes matching nodeAffinity/nodeSelector are included in the calculations. - Ignore: nodeAffinity/nodeSelector are ignored. All nodes are included in the calculations. - If this value is nil, the behavior is equivalent to the Honor policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ If this value is nil, the behavior is equivalent to the Honor policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
false
string NodeTaintsPolicy indicates how we will treat node taints when calculating pod topology spread skew. Options are: - Honor: nodes without taints, along with tainted nodes for which the incoming pod has a toleration, are included. - Ignore: node taints are ignored. All nodes are included. - If this value is nil, the behavior is equivalent to the Ignore policy. This is a alpha-level feature enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
+ If this value is nil, the behavior is equivalent to the Ignore policy. This is a beta-level feature default enabled by the NodeInclusionPolicyInPodTopologySpread feature flag.
false
proxyPortintegeragentobject - Port of Konnectivity proxy server.

- Format: int32
+
+ Default: map[image:registry.k8s.io/kas-network-proxy/proxy-agent version:v0.0.32]
truefalse
agentImageserverobject +
+
+ Default: map[image:registry.k8s.io/kas-network-proxy/proxy-server port:8132 version:v0.0.32]
+
false
+ + +### TenantControlPlane.spec.addons.konnectivity.agent + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - @@ -2992,7 +3020,67 @@ Enables the Konnectivity addon in the Tenant Cluster, required if the worker nod
NameTypeDescriptionRequired
extraArgs[]string + ExtraArgs allows adding additional arguments to said component.
+
false
image string AgentImage defines the container image for Konnectivity's agent.
@@ -2963,27 +3007,11 @@ Enables the Konnectivity addon in the Tenant Cluster, required if the worker nod Default: registry.k8s.io/kas-network-proxy/proxy-agent
false
resourcesobject - Resources define the amount of CPU and memory to allocate to the Konnectivity server.
-
false
serverImagestring - ServerImage defines the container image for Konnectivity's server.
-
- Default: registry.k8s.io/kas-network-proxy/proxy-server
-
false
version string - Version for Konnectivity server and agent.
+ Version for Konnectivity agent.

Default: v0.0.32
-### TenantControlPlane.spec.addons.konnectivity.resources +### TenantControlPlane.spec.addons.konnectivity.server + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeDescriptionRequired
portinteger + The port which Konnectivity server is listening to.
+
+ Format: int32
+
true
extraArgs[]string + ExtraArgs allows adding additional arguments to said component.
+
false
imagestring + Container image used by the Konnectivity server.
+
+ Default: registry.k8s.io/kas-network-proxy/proxy-server
+
false
resourcesobject + Resources define the amount of CPU and memory to allocate to the Konnectivity server.
+
false
versionstring + Container image version of the Konnectivity server.
+
+ Default: v0.0.32
+
false
+ + +### TenantControlPlane.spec.addons.konnectivity.server.resources @@ -3272,13 +3360,6 @@ AddonStatus defines the observed state of an Addon.
true - - checksum - string - -
- - false lastUpdate string @@ -3383,13 +3464,6 @@ KonnectivityStatus defines the status of Konnectivity as Addon. - checksum - string - -
- - false - lastUpdate string @@ -3474,13 +3548,6 @@ CertificatePrivateKeyPairStatus defines the status. - checksum - string - -
- - false - lastUpdate string @@ -3598,13 +3665,6 @@ KubeconfigStatus contains information about the generated kubeconfig. - checksum - string - -
- - false - lastUpdate string @@ -3889,13 +3949,6 @@ AddonStatus defines the observed state of an Addon.
true - - checksum - string - -
- - false lastUpdate string @@ -4368,20 +4421,6 @@ KubeadmPhase contains the status of the kubeadm phases action KubeadmPhaseStatus contains the status of a kubeadm phase action.
true - - uploadConfigKubeadm - object - - KubeadmPhaseStatus contains the status of a kubeadm phase action.
- - true - - uploadConfigKubelet - object - - KubeadmPhaseStatus contains the status of a kubeadm phase action.
- - true @@ -4390,76 +4429,6 @@ KubeadmPhase contains the status of the kubeadm phases action -KubeadmPhaseStatus contains the status of a kubeadm phase action. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
checksumstring -
-
false
lastUpdatestring -
-
- Format: date-time
-
false
- - -### TenantControlPlane.status.kubeadmPhase.uploadConfigKubeadm - - - -KubeadmPhaseStatus contains the status of a kubeadm phase action. - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescriptionRequired
checksumstring -
-
false
lastUpdatestring -
-
- Format: date-time
-
false
- - -### TenantControlPlane.status.kubeadmPhase.uploadConfigKubelet - - - KubeadmPhaseStatus contains the status of a kubeadm phase action. @@ -4989,7 +4958,7 @@ LoadBalancer contains the current status of the load-balancer. @@ -5000,7 +4969,7 @@ LoadBalancer contains the current status of the load-balancer. -LoadBalancerIngress represents the status of a load-balancer ingress point: traffic intended for the service should be sent to an ingress point. +IngressLoadBalancerIngress represents the status of a load-balancer ingress point.
ingress []object - Ingress is a list containing ingress points for the load-balancer. Traffic intended for the service should be sent to these ingress points.
+ Ingress is a list containing ingress points for the load-balancer.
false
@@ -5015,21 +4984,21 @@ LoadBalancerIngress represents the status of a load-balancer ingress point: traf @@ -5040,7 +5009,7 @@ LoadBalancerIngress represents the status of a load-balancer ingress point: traf - +IngressPortStatus represents the error condition of a service port
hostname string - Hostname is set for load-balancer ingress points that are DNS based (typically AWS load-balancers)
+ Hostname is set for load-balancer ingress points that are DNS based.
false
ip string - IP is set for load-balancer ingress points that are IP based (typically GCE or OpenStack load-balancers)
+ IP is set for load-balancer ingress points that are IP based.
false
ports []object - Ports is a list of records of service ports If used, every port defined in the service should have an entry in it
+ Ports provides information about the ports exposed by this LoadBalancer.
false
@@ -5055,7 +5024,7 @@ LoadBalancerIngress represents the status of a load-balancer ingress point: traf @@ -5064,7 +5033,7 @@ LoadBalancerIngress represents the status of a load-balancer ingress point: traf @@ -5337,7 +5306,7 @@ KubernetesVersion contains the information regarding the running Kubernetes vers
port integer - Port is the port number of the service port of which status is recorded here
+ Port is the port number of the ingress port.

Format: int32
protocol string - Protocol is the protocol of the service port of which status is recorded here The supported values are: "TCP", "UDP", "SCTP"
+ Protocol is the protocol of the ingress port. The supported values are: "TCP", "UDP", "SCTP"

Default: TCP
Status returns the current status of the Kubernetes version, such as its provisioning state, or completed upgrade.

- Enum: Provisioning, Upgrading, Ready, NotReady
+ Enum: Provisioning, Upgrading, Migrating, Ready, NotReady
Default: Provisioning
false