Node Provider
NodeProvider holds the node provider information
NodeProvider example
An example NodeProvider:
apiVersion: management.loft.sh/v1
kind: NodeProvider
metadata: {}
spec:
displayName: Terraform Example
terraform:
nodeTemplate:
git:
repository: https://github.com/my-org/my-repo.git
nodeTypes:
- metadata: {}
name: medium
properties:
instance-type: t3.medium
resources:
cpu: "2"
memory: 4Gi
- metadata: {}
name: large
properties:
instance-type: t3.large
resources:
cpu: "2"
memory: 8Gi
- metadata: {}
name: xlarge
properties:
instance-type: c5.xlarge
resources:
cpu: "4"
memory: 8Gi
status: {}
NodeProvider reference
kind required string
Kind is a string value representing the REST resource this object represents.
Servers may infer this from the endpoint the client submits requests to.
Cannot be updated.
In CamelCase.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind required string apiVersion required string
APIVersion defines the versioned schema of this representation of an object.
Servers should convert recognized schemas to the latest internal value, and
may reject unrecognized values.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
apiVersion required string metadata required object
metadata required object name required string
Name must be unique within a namespace. Is required when creating resources, although
some resources may allow a client to request the generation of an appropriate name
automatically. Name is primarily intended for creation idempotence and configuration
definition.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name required string generateName required string
GenerateName is an optional prefix, used by the server, to generate a unique
name ONLY IF the Name field has not been provided.
If this field is used, the name returned to the client will be different
than the name passed. This value will also be combined with a unique suffix.
The provided value has the same validation rules as the Name field,
and may be truncated by the length of the suffix required to make the value
unique on the server.
If this field is specified and the generated name exists, the server will return a 409.
Applied only if Name is not specified.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency
generateName required string namespace required string
Namespace defines the space within which each name must be unique. An empty namespace is
equivalent to the "default" namespace, but "default" is the canonical representation.
Not all objects are required to be scoped to a namespace - the value of this field for
those objects will be empty.
Must be a DNS_LABEL.
Cannot be updated.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces
namespace required string selfLink required string
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink required string uid required string
UID is the unique in time and space value for this object. It is typically generated by
the server on successful creation of a resource and is not allowed to change on PUT
operations.
Populated by the system.
Read-only.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid required string resourceVersion required string
An opaque value that represents the internal version of this object that can
be used by clients to determine when objects have changed. May be used for optimistic
concurrency, change detection, and the watch operation on a resource or set of resources.
Clients must treat these values as opaque and passed unmodified back to the server.
They may only be valid for a particular resource or set of resources.
Populated by the system.
Read-only.
Value must be treated as opaque by clients and .
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
resourceVersion required string generation required integer
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation required integer creationTimestamp required object
CreationTimestamp is a timestamp representing the server time when this object was
created. It is not guaranteed to be set in happens-before order across separate operations.
Clients may not set this value. It is represented in RFC3339 form and is in UTC.
Populated by the system.
Read-only.
Null for lists.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
creationTimestamp required object deletionTimestamp required object
DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This
field is set by the server when a graceful deletion is requested by the user, and is not
directly settable by a client. The resource is expected to be deleted (no longer visible
from resource lists, and not reachable by name) after the time in this field, once the
finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.
Once the deletionTimestamp is set, this value may not be unset or be set further into the
future, although it may be shortened or the resource may be deleted prior to this time.
For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react
by sending a graceful termination signal to the containers in the pod. After that 30 seconds,
the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,
remove the pod from the API. In the presence of network partitions, this object may still
exist after this timestamp, until an administrator or automated process can determine the
resource is fully terminated.
If not set, graceful deletion of the object has not been requested.
Populated by the system when a graceful deletion is requested.
Read-only.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata
deletionTimestamp required object deletionGracePeriodSeconds required integer
Number of seconds allowed for this object to gracefully terminate before
it will be removed from the system. Only set when deletionTimestamp is also set.
May only be shortened.
Read-only.
deletionGracePeriodSeconds required integer labels required object
Map of string keys and values that can be used to organize and categorize
(scope and select) objects. May match selectors of replication controllers
and services.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels
labels required object annotations required object
Annotations is an unstructured key value map stored with a resource that may be
set by external tools to store and retrieve arbitrary metadata. They are not
queryable and should be preserved when modifying objects.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations
annotations required object ownerReferences required object[]
List of objects depended by this object. If ALL objects in the list have
been deleted, this object will be garbage collected. If this object is managed by a controller,
then an entry in this list will point to this controller, with the controller field set to true.
There cannot be more than one managing controller.
ownerReferences required object[] apiVersion required string
API version of the referent.
apiVersion required string kind required string
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind required string name required string
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name required string uid required string
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid required string controller required boolean
If true, this reference points to the managing controller.
controller required boolean blockOwnerDeletion required boolean
If true, AND if the owner has the "foregroundDeletion" finalizer, then
the owner cannot be deleted from the key-value store until this
reference is removed.
See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion
for how the garbage collector interacts with this field and enforces the foreground deletion.
Defaults to false.
To set this field, a user needs "delete" permission of the owner,
otherwise 422 (Unprocessable Entity) will be returned.
blockOwnerDeletion required boolean finalizers required string[]
Must be empty before the object is deleted from the registry. Each entry
is an identifier for the responsible component that will remove the entry
from the list. If the deletionTimestamp of the object is non-nil, entries
in this list can only be removed.
Finalizers may be processed and removed in any order. Order is NOT enforced
because it introduces significant risk of stuck finalizers.
finalizers is a shared field, any actor with permission can reorder it.
If the finalizer list is processed in order, then this can lead to a situation
in which the component responsible for the first finalizer in the list is
waiting for a signal (field value, external system, or other) produced by a
component responsible for a finalizer later in the list, resulting in a deadlock.
Without enforced ordering finalizers are free to order amongst themselves and
are not vulnerable to ordering changes in the list.
finalizers required string[] managedFields required object[]
ManagedFields maps workflow-id and version to the set of fields
that are managed by that workflow. This is mostly for internal
housekeeping, and users typically shouldn't need to set or
understand this field. A workflow can be the user's name, a
controller's name, or the name of a specific apply path like
"ci-cd". The set of fields is always in the version that the
workflow used when modifying the object.
managedFields required object[] manager required string
Manager is an identifier of the workflow managing these fields.
manager required string operation required string
Operation is the type of operation which lead to this ManagedFieldsEntry being created.
The only valid values for this field are 'Apply' and 'Update'.
operation required string apiVersion required string
APIVersion defines the version of this resource that this field set
applies to. The format is "group/version" just like the top-level
APIVersion field. It is necessary to track the version of a field
set because it cannot be automatically converted.
apiVersion required string time required object
Time is the timestamp of when the ManagedFields entry was added. The
timestamp will also be updated if a field is added, the manager
changes any of the owned fields value or removes a field. The
timestamp does not update when a field is removed from the entry
because another manager took it over.
time required object fieldsType required string
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType required string fieldsV1 required object
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1 required object subresource required string
Subresource is the name of the subresource used to update that object, or
empty string if the object was updated through the main resource. The
value of this field is used to distinguish between managers, even if they
share the same name. For example, a status update will be distinct from a
regular update using the same manager name.
Note that the APIVersion field is not related to the Subresource field and
it always corresponds to the version of the main resource.
subresource required string spec required object
spec required object properties required object
Properties are global properties that are applied to all node claims and environments managed by this provider.
properties required object bcm required object
BCM configures a node provider for BCM Bare Metal Cloud environments.
bcm required object secretRef required object
SecretRef is a reference to secret with keys for BCM auth.
secretRef required object endpoint required string
Endpoint is a address for head node.
endpoint required string nodeTypes required object[]
NodeTypes define NodeTypes that should be automatically created for this provider.
nodeTypes required object[] providerRef required string
ProviderRef is the node provider to use for this node type.
providerRef required string properties required object
Properties returns a flexible set of properties that may be selected for scheduling.
properties required object resources required object
Resources lists the full resources for a single node.
resources required object overhead required object
Overhead defines the resource overhead for this node type.
overhead required object kubeReserved required object
KubeReserved is the resource overhead for kubelet and other Kubernetes system daemons.
kubeReserved required object cost required integer
Cost is the instance cost. The higher the cost, the less likely it is to be selected. If empty, cost is automatically calculated
from the resources specified.
cost required integer displayName required string
DisplayName is the name that should be displayed in the UI
displayName required string name required string
Name is the name of this node type.
name required string metadata required object
Metadata holds metadata to add to this managed NodeType.
metadata required object nodes required string[]
Nodes specifies nodes.
nodes required string[] nodeGroups required string[]
NodeGroups is the name of the node groups to use for this provider.
nodeGroups required string[] kubeVirt required object
Kubevirt configures a node provider using KubeVirt, enabling virtual machines
to be provisioned as nodes within a vCluster.
kubeVirt required object clusterRef required object
ClusterRef is a reference to connected host cluster in which KubeVirt operator is running
clusterRef required object virtualMachineTemplate required object
VirtualMachineTemplate is a KubeVirt VirtualMachine template to use by NodeTypes managed by this NodeProvider
virtualMachineTemplate required object nodeTypes required object[]
NodeTypes define NodeTypes that should be automatically created for this provider.
nodeTypes required object[] providerRef required string
ProviderRef is the node provider to use for this node type.
providerRef required string properties required object
Properties returns a flexible set of properties that may be selected for scheduling.
properties required object resources required object
Resources lists the full resources for a single node.
resources required object overhead required object
Overhead defines the resource overhead for this node type.
overhead required object kubeReserved required object
KubeReserved is the resource overhead for kubelet and other Kubernetes system daemons.
kubeReserved required object cost required integer
Cost is the instance cost. The higher the cost, the less likely it is to be selected. If empty, cost is automatically calculated
from the resources specified.
cost required integer displayName required string
DisplayName is the name that should be displayed in the UI
displayName required string name required string
Name is the name of this node type.
name required string metadata required object
Metadata holds metadata to add to this managed NodeType.
metadata required object virtualMachineTemplate required object
VirtualMachineTemplate is a full KubeVirt VirtualMachine template to use for this NodeType.
This is mutually exclusive with MergeVirtualMachineTemplate
virtualMachineTemplate required object mergeVirtualMachineTemplate required object
MergeVirtualMachineTemplate will be merged into base VirtualMachine template for this NodeProvider.
This allows overwriting of specific fields from top level template by individual NodeTypes
This is mutually exclusive with VirtualMachineTemplate
mergeVirtualMachineTemplate required object maxCapacity required integer
MaxCapacity is the maximum number of nodes that can be created for this NodeType.
maxCapacity required integer terraform required object
Terraform configures a node provider using Terraform, enabling nodes to be provisioned using Terraform.
terraform required object nodeTemplate required object
NodeTemplate is the template to use for this node provider.
nodeTemplate required object inline required string
Inline is the inline template to use for this node type.
inline required string git required object
Git is the git repository to use for this node type.
git required object repository required string
Repository is the repository to clone
repository required string branch required string
Branch is the branch to use
branch required string commit required string
Commit is the commit SHA to checkout
commit required string tag required string
Tag is the tag reference to checkout
tag required string subPath required string
SubPath is the subpath in the repo to use
subPath required string credentials required object
Credentials is the reference to a secret containing the username and password for the git repository.
credentials required object fetchInterval required string
FetchInterval is the interval to use for refetching the git repository. Defaults to 5m. Refetching only checks for remote changes but does not do a complete repull.
fetchInterval required string extraEnv required string[]
ExtraEnv is the extra environment variables to use for the clone
extraEnv required string[] timeout required string
Timeout is the timeout to use for the terraform operations. Defaults to 60m.
timeout required string nodeEnvironmentTemplate required object
NodeEnvironmentTemplate is the template to use for this node environment.
nodeEnvironmentTemplate required object inline required string
Inline is the inline template to use for this node type.
inline required string git required object
Git is the git repository to use for this node type.
git required object repository required string
Repository is the repository to clone
repository required string branch required string
Branch is the branch to use
branch required string commit required string
Commit is the commit SHA to checkout
commit required string tag required string
Tag is the tag reference to checkout
tag required string subPath required string
SubPath is the subpath in the repo to use
subPath required string credentials required object
Credentials is the reference to a secret containing the username and password for the git repository.
credentials required object fetchInterval required string
FetchInterval is the interval to use for refetching the git repository. Defaults to 5m. Refetching only checks for remote changes but does not do a complete repull.
fetchInterval required string extraEnv required string[]
ExtraEnv is the extra environment variables to use for the clone
extraEnv required string[] timeout required string
Timeout is the timeout to use for the terraform operations. Defaults to 60m.
timeout required string infrastructure required object
Infrastructure is the infrastructure template to use for this node environment.
infrastructure required object inline required string
Inline is the inline template to use for this node type.
inline required string git required object
Git is the git repository to use for this node type.
git required object repository required string
Repository is the repository to clone
repository required string branch required string
Branch is the branch to use
branch required string commit required string
Commit is the commit SHA to checkout
commit required string tag required string
Tag is the tag reference to checkout
tag required string subPath required string
SubPath is the subpath in the repo to use
subPath required string credentials required object
Credentials is the reference to a secret containing the username and password for the git repository.
credentials required object fetchInterval required string
FetchInterval is the interval to use for refetching the git repository. Defaults to 5m. Refetching only checks for remote changes but does not do a complete repull.
fetchInterval required string extraEnv required string[]
ExtraEnv is the extra environment variables to use for the clone
extraEnv required string[] timeout required string
Timeout is the timeout to use for the terraform operations. Defaults to 60m.
timeout required string kubernetes required object
Kubernetes is the kubernetes template to use for this node environment.
kubernetes required object inline required string
Inline is the inline template to use for this node type.
inline required string git required object
Git is the git repository to use for this node type.
git required object repository required string
Repository is the repository to clone
repository required string branch required string
Branch is the branch to use
branch required string commit required string
Commit is the commit SHA to checkout
commit required string tag required string
Tag is the tag reference to checkout
tag required string subPath required string
SubPath is the subpath in the repo to use
subPath required string credentials required object
Credentials is the reference to a secret containing the username and password for the git repository.
credentials required object fetchInterval required string
FetchInterval is the interval to use for refetching the git repository. Defaults to 5m. Refetching only checks for remote changes but does not do a complete repull.
fetchInterval required string extraEnv required string[]
ExtraEnv is the extra environment variables to use for the clone
extraEnv required string[] timeout required string
Timeout is the timeout to use for the terraform operations. Defaults to 60m.
timeout required string nodeTypes required object[]
NodeTypes define NodeTypes that should be automatically created for this provider.
nodeTypes required object[] providerRef required string
ProviderRef is the node provider to use for this node type.
providerRef required string properties required object
Properties returns a flexible set of properties that may be selected for scheduling.
properties required object resources required object
Resources lists the full resources for a single node.
resources required object overhead required object
Overhead defines the resource overhead for this node type.
overhead required object kubeReserved required object
KubeReserved is the resource overhead for kubelet and other Kubernetes system daemons.
kubeReserved required object cost required integer
Cost is the instance cost. The higher the cost, the less likely it is to be selected. If empty, cost is automatically calculated
from the resources specified.
cost required integer displayName required string
DisplayName is the name that should be displayed in the UI
displayName required string name required string
Name is the name of this node type.
name required string metadata required object
Metadata holds metadata to add to this managed NodeType.
metadata required object nodeTemplate required object
NodeTemplate is the template to use for this node type.
nodeTemplate required object inline required string
Inline is the inline template to use for this node type.
inline required string git required object
Git is the git repository to use for this node type.
git required object repository required string
Repository is the repository to clone
repository required string branch required string
Branch is the branch to use
branch required string commit required string
Commit is the commit SHA to checkout
commit required string tag required string
Tag is the tag reference to checkout
tag required string subPath required string
SubPath is the subpath in the repo to use
subPath required string credentials required object
Credentials is the reference to a secret containing the username and password for the git repository.
credentials required object fetchInterval required string
FetchInterval is the interval to use for refetching the git repository. Defaults to 5m. Refetching only checks for remote changes but does not do a complete repull.
fetchInterval required string extraEnv required string[]
ExtraEnv is the extra environment variables to use for the clone
extraEnv required string[] timeout required string
Timeout is the timeout to use for the terraform operations. Defaults to 60m.
timeout required string maxCapacity required integer
MaxCapacity is the maximum number of nodes that can be created for this NodeType.
maxCapacity required integer clusterAPI required object
ClusterAPI configures a node provider using Cluster API, enabling nodes to be provisioned using Cluster API.
This requires the vCluster to be deployed with Cluster API as well.
clusterAPI required object infrastructureMachineTemplate required object
InfrastructureMachineTemplate is a template for the infrastructure machine, e.g. AWSMachine
infrastructureMachineTemplate required object bootstrapConfigTemplate required object
BootstrapConfigTemplate is a template for the bootstrap config. Currently only KubeadmConfig is supported.
bootstrapConfigTemplate required object clusterRef required object
ClusterRef is a reference to connected host cluster in which KubeVirt operator is running
clusterRef required object nodeTypes required object[]
NodeTypes define NodeTypes that should be automatically created for this provider.
nodeTypes required object[] providerRef required string
ProviderRef is the node provider to use for this node type.
providerRef required string properties required object
Properties returns a flexible set of properties that may be selected for scheduling.
properties required object resources required object
Resources lists the full resources for a single node.
resources required object overhead required object
Overhead defines the resource overhead for this node type.
overhead required object kubeReserved required object
KubeReserved is the resource overhead for kubelet and other Kubernetes system daemons.
kubeReserved required object cost required integer
Cost is the instance cost. The higher the cost, the less likely it is to be selected. If empty, cost is automatically calculated
from the resources specified.
cost required integer displayName required string
DisplayName is the name that should be displayed in the UI
displayName required string name required string
Name is the name of this node type.
name required string metadata required object
Metadata holds metadata to add to this managed NodeType.
metadata required object infrastructureMachineTemplate required object
InfrastructureMachineTemplate is a template for the infrastructure machine, e.g. AWSMachine
infrastructureMachineTemplate required object bootstrapConfigTemplate required object
BootstrapConfigTemplate is a template for the bootstrap config. Currently only KubeadmConfig is supported.
bootstrapConfigTemplate required object mergeInfrastructureMachineTemplate required object
MergeInfrastructureMachineTemplate will be merged into base InfrastructureMachine template for this NodeProvider.
This allows overwriting of specific fields from top level template by individual NodeTypes
This is mutually exclusive with InfrastructureMachineTemplate
mergeInfrastructureMachineTemplate required object mergeBootstrapConfigTemplate required object
MergeBootstrapConfigTemplate will be merged into base BootstrapConfig template for this NodeProvider.
This allows overwriting of specific fields from top level template by individual NodeTypes
This is mutually exclusive with BootstrapConfigTemplate
mergeBootstrapConfigTemplate required object maxCapacity required integer
MaxCapacity is the maximum number of nodes that can be created for this NodeType.
maxCapacity required integer displayName required string
DisplayName is the name that should be displayed in the UI
displayName required string status required object
status required object conditions required object
Conditions describe the current state of the platform NodeProvider.
conditions required object reason required string
Reason describes the reason in machine-readable form
reason required string phase required string
Phase is the current lifecycle phase of the NodeProvider.
phase required string message required string
Message is a human-readable message indicating details about why the NodeProvider is in its current state.
message required string Create: NodeProvider
You can either use curl or kubectl to create a new NodeProvider.
- kubectl
- curl
Create a file object.yaml with the following contents:
apiVersion: management.loft.sh/v1
kind: NodeProvider
metadata: {}
spec:
displayName: Terraform Example
terraform:
nodeTemplate:
git:
repository: https://github.com/my-org/my-repo.git
nodeTypes:
- metadata: {}
name: medium
properties:
instance-type: t3.medium
resources:
cpu: "2"
memory: 4Gi
- metadata: {}
name: large
properties:
instance-type: t3.large
resources:
cpu: "2"
memory: 8Gi
- metadata: {}
name: xlarge
properties:
instance-type: c5.xlarge
resources:
cpu: "4"
memory: 8Gi
status: {}
Then create the NodeProvider my-object with:
kubectl create -f object.yaml
Create a file object.yaml with the following contents:
apiVersion: management.loft.sh/v1
kind: NodeProvider
metadata: {}
spec:
displayName: Terraform Example
terraform:
nodeTemplate:
git:
repository: https://github.com/my-org/my-repo.git
nodeTypes:
- metadata: {}
name: medium
properties:
instance-type: t3.medium
resources:
cpu: "2"
memory: 4Gi
- metadata: {}
name: large
properties:
instance-type: t3.large
resources:
cpu: "2"
memory: 8Gi
- metadata: {}
name: xlarge
properties:
instance-type: c5.xlarge
resources:
cpu: "4"
memory: 8Gi
status: {}
Run the following curl command to create a new NodeProvider my-object:
curl -s -X POST --insecure \
"https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/nodeproviders" \
--data-binary "$(cat object.yaml)" \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY"