You are looking at the documentation of a prior release. To read the documentation of the latest release, please visit here.

NodebalancerConfig

FieldTypeDescription
apiVersionstringlinode.kubeform.com/v1alpha1
kindstringNodebalancerConfig
metadataKubernetes meta/v1.ObjectMetaRefer to the Kubernetes API documentation for the fields of the metadata field.
specNodebalancerConfigSpec
statusNodebalancerConfigStatus

NodebalancerConfigSpec

Appears on:NodebalancerConfig, NodebalancerConfigStatus

FieldTypeDescription
providerRefKubernetes core/v1.LocalObjectReference
idstring
secretRefKubernetes core/v1.LocalObjectReference
algorithmstring(Optional) What algorithm this NodeBalancer should use for routing traffic to backends: roundrobin, leastconn, source
checkstring(Optional) The type of check to perform against backends to ensure they are serving requests. This is used to determine if backends are up or down. If none no check is performed. connection requires only a connection to the backend to succeed. http and http_body rely on the backend serving HTTP, and that the response returned matches what is expected.
checkAttemptsint64(Optional) How many times to attempt a check before considering a backend to be down. (1-30)
checkBodystring(Optional) This value must be present in the response body of the check in order for it to pass. If this value is not present in the response body of a check request, the backend is considered to be down
checkIntervalint64(Optional) How often, in seconds, to check that backends are up and serving requests.
checkPassivebool(Optional) If true, any response from this backend with a 5xx status code will be enough for it to be considered unhealthy and taken out of rotation.
checkPathstring(Optional) The URL path to check on each backend. If the backend does not respond to this request it is considered to be down.
checkTimeoutint64(Optional) How long, in seconds, to wait for a check attempt before considering it failed. (1-30)
cipherSuitestring(Optional) What ciphers to use for SSL connections served by this NodeBalancer. legacy is considered insecure and should only be used if necessary.
nodeStatusmap[string]kubeform.dev/kubeform/apis/linode/v1alpha1.NodebalancerConfigSpecNodeStatus(Optional)
nodebalancerIDint64The ID of the NodeBalancer to access.
portint64(Optional) The TCP port this Config is for. These values must be unique across configs on a single NodeBalancer (you can’t have two configs for port 80, for example). While some ports imply some protocols, no enforcement is done and you may configure your NodeBalancer however is useful to you. For example, while port 443 is generally used for HTTPS, you do not need SSL configured to have a NodeBalancer listening on port 443.
protocolstring(Optional) The protocol this port is configured to serve. If this is set to https you must include an ssl_cert and an ssl_key.
sslCertstring(Optional) The certificate this port is serving. This is not returned. If set, this field will come back as <REDACTED>. Please use the ssl_commonname and ssl_fingerprint to identify the certificate.
sslCommonnamestring(Optional) The common name for the SSL certification this port is serving if this port is not configured to use SSL.
sslFingerprintstring(Optional) The fingerprint for the SSL certification this port is serving if this port is not configured to use SSL.
stickinessstring(Optional) Controls how session stickiness is handled on this port: ’none’, ’table’, ‘http_cookie’

NodebalancerConfigStatus

Appears on:NodebalancerConfig

FieldTypeDescription
observedGenerationint64(Optional) Resource generation, which is updated on mutation by the API Server.
outputNodebalancerConfigSpec(Optional)
statekubeform.dev/kubeform/apis/base/v1alpha1.State(Optional)
phasePhase(Optional)

Phase(string alias)

Appears on:NodebalancerConfigStatus


Sensitive Values

NameTypeDescription
ssl_keystringThe private key corresponding to this port’s certificate. This is not returned. If set, this field will come back as <REDACTED>. Please use the ssl_commonname and ssl_fingerprint to identify the certificate.