Virtual Cluster Instance
A virtual cluster is a fully functional Kubernetes cluster that runs inside the namespace of another Kubernetes cluster (host cluster). Virtual clusters are very useful if you are hitting the limits of namespaces and do not want to make special exceptions to the multi-tenancy configuration of the underlying cluster, e.g. a user needs their own CRD or user needs pods from 2 namespaces to communicate with each other but your standard NetworkPolicy does not allow this, then a virtual cluster may be perfect for this user.
Example Virtual Cluster​
An example Virtual Cluster:
apiVersion: management.loft.sh/v1
kind: VirtualClusterInstance
metadata:
creationTimestamp: null
name: my-virtual-cluster
namespace: loft-p-my-project
spec:
clusterRef: {}
displayName: my-display-name
owner:
user: my-user
parameters: 'my-parameter: my-value'
templateRef:
name: my-virtual-cluster-template
status: {}
Virtual Cluster Reference​
kind
required string pro​
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 pro​apiVersion
required string pro​
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 pro​metadata
required object pro​
metadata
required object pro​name
required string pro​
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 pro​generateName
required string pro​
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 pro​namespace
required string pro​
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 pro​selfLink
required string pro​
Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.
selfLink
required string pro​uid
required string pro​
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 pro​resourceVersion
required string pro​
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 pro​generation
required integer pro​
A sequence number representing a specific generation of the desired state.
Populated by the system. Read-only.
generation
required integer pro​creationTimestamp
required object pro​
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 pro​deletionTimestamp
required object pro​
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 pro​deletionGracePeriodSeconds
required integer pro​
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 pro​labels
required object pro​
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 pro​annotations
required object pro​
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 pro​ownerReferences
required object[] pro​
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[] pro​apiVersion
required string pro​
API version of the referent.
apiVersion
required string pro​kind
required string pro​
Kind of the referent.
More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
kind
required string pro​name
required string pro​
Name of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names
name
required string pro​uid
required string pro​
UID of the referent.
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids
uid
required string pro​controller
required boolean pro​
If true, this reference points to the managing controller.
controller
required boolean pro​blockOwnerDeletion
required boolean pro​
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 pro​finalizers
required string[] pro​
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[] pro​managedFields
required object[] pro​
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[] pro​manager
required string pro​
Manager is an identifier of the workflow managing these fields.
manager
required string pro​operation
required string pro​
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 pro​apiVersion
required string pro​
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 pro​time
required object pro​
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 pro​fieldsType
required string pro​
FieldsType is the discriminator for the different fields format and version.
There is currently only one possible value: "FieldsV1"
fieldsType
required string pro​fieldsV1
required object pro​
FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.
fieldsV1
required object pro​subresource
required string pro​
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 pro​spec
required object pro​
spec
required object pro​displayName
required string pro​
DisplayName is the name that should be displayed in the UI
displayName
required string pro​description
required string pro​
Description describes a virtual cluster instance
description
required string pro​owner
required object pro​
Owner holds the owner of this object
owner
required object pro​templateRef
required object pro​
TemplateRef holds the virtual cluster template reference
templateRef
required object pro​name
required string pro​
Name holds the name of the template to reference.
name
required string pro​version
required string pro​
Version holds the template version to use. Version is expected to
be in semantic versioning format. Alternatively, you can also exchange
major, minor or patch with an 'x' to tell Loft to automatically select
the latest major, minor or patch version.
version
required string pro​syncOnce
required boolean pro​
SyncOnce tells the controller to sync the instance once with the template.
This is useful if you want to sync an instance after a template was changed.
To automatically sync an instance with a template, use 'x.x.x' as version
instead.
syncOnce
required boolean pro​template
required object pro​
Template is the inline template to use for virtual cluster creation. This is mutually
exclusive with templateRef.
template
required object pro​metadata
required object pro​
metadata
required object pro​instanceTemplate
required object pro​
InstanceTemplate holds the virtual cluster instance template
instanceTemplate
required object pro​apps
required object[] pro​
Apps specifies the apps that should get deployed by this template
apps
required object[] pro​name
required string pro​
Name of the target app
name
required string pro​namespace
required string pro​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string pro​releaseName
required string pro​
ReleaseName is the name of the app release
releaseName
required string pro​version
required string pro​
Version of the app
version
required string pro​parameters
required string pro​
Parameters to use for the app
parameters
required string pro​charts
required object[] pro​
Charts are helm charts that should get deployed
charts
required object[] pro​name
required string pro​
Name is the chart name in the repository
name
required string pro​version
required string pro​
Version is the chart version in the repository
version
required string pro​repoURL
required string pro​
RepoURL is the repo url where the chart can be found
repoURL
required string pro​username
required string pro​
The username that is required for this repository
username
required string pro​usernameRef
required object pro​
The username that is required for this repository
usernameRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​password
required string pro​
The password that is required for this repository
password
required string pro​passwordRef
required object pro​
The password that is required for this repository
passwordRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​insecureSkipTlsVerify
required boolean pro​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean pro​releaseName
required string pro​
ReleaseName is the preferred release name of the app
releaseName
required string pro​releaseNamespace
required string pro​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string pro​values
required string pro​
Values are the values that should get passed to the chart
values
required string pro​wait
required boolean pro​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean pro​timeout
required string pro​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string pro​objects
required string pro​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string pro​access
required object pro​
Access defines the access of users and teams to the virtual cluster.
access
required object pro​defaultClusterRole
required string pro​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string pro​rules
required object[] pro​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] pro​pro
required object pro​
Pro defines the pro settings for the virtual cluster
pro
required object pro​enabled
required boolean pro​
Enabled defines if the virtual cluster is a pro cluster or not
enabled
required boolean pro​helmRelease
required object pro​
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease
required object pro​chart
required object pro​
infos about what chart to deploy
chart
required object pro​name
required string pro​
the name of the helm chart
name
required string pro​repo
required string pro​
the repo of the helm chart
repo
required string pro​username
required string pro​
The username that is required for this repository
username
required string pro​password
required string pro​
The password that is required for this repository
password
required string pro​version
required string pro​
the version of the helm chart to use
version
required string pro​values
required string pro​
the values for the given chart
values
required string pro​accessPoint
required object pro​
AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than
through the (default) Loft proxy
accessPoint
required object pro​ingress
required object pro​
Ingress defines virtual cluster access via ingress
ingress
required object pro​enabled
required boolean pro​
Enabled defines if the virtual cluster access point (via ingress) is enabled or not; requires
the connected cluster to have the loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.
enabled
required boolean pro​loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.forwardToken
required boolean pro​
ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes
api server and do a TokenReview there.
forwardToken
required boolean pro​spaceTemplate
required object pro​
SpaceTemplate holds the space template
spaceTemplate
required object pro​metadata
required object pro​
metadata
required object pro​objects
required string pro​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects
required string pro​charts
required object[] pro​
Charts are helm charts that should get deployed
charts
required object[] pro​name
required string pro​
Name is the chart name in the repository
name
required string pro​version
required string pro​
Version is the chart version in the repository
version
required string pro​repoURL
required string pro​
RepoURL is the repo url where the chart can be found
repoURL
required string pro​username
required string pro​
The username that is required for this repository
username
required string pro​usernameRef
required object pro​
The username that is required for this repository
usernameRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​password
required string pro​
The password that is required for this repository
password
required string pro​passwordRef
required object pro​
The password that is required for this repository
passwordRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​insecureSkipTlsVerify
required boolean pro​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean pro​releaseName
required string pro​
ReleaseName is the preferred release name of the app
releaseName
required string pro​releaseNamespace
required string pro​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string pro​values
required string pro​
Values are the values that should get passed to the chart
values
required string pro​wait
required boolean pro​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean pro​timeout
required string pro​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string pro​apps
required object[] pro​
Apps specifies the apps that should get deployed by this template
apps
required object[] pro​name
required string pro​
Name of the target app
name
required string pro​namespace
required string pro​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string pro​releaseName
required string pro​
ReleaseName is the name of the app release
releaseName
required string pro​version
required string pro​
Version of the app
version
required string pro​parameters
required string pro​
Parameters to use for the app
parameters
required string pro​clusterRef
required object pro​
ClusterRef is the reference to the connected cluster holding
this virtual cluster
clusterRef
required object pro​cluster
required string pro​
Cluster is the connected cluster the space will be created in
cluster
required string pro​namespace
required string pro​
Namespace is the namespace inside the connected cluster holding the space
namespace
required string pro​virtualCluster
required string pro​
VirtualCluster is the name of the virtual cluster inside the namespace
virtualCluster
required string pro​parameters
required string pro​
Parameters are values to pass to the template.
The values should be encoded as YAML string where each parameter is represented as a top-level field key.
parameters
required string pro​extraAccessRules
required object[] pro​
ExtraAccessRules defines extra rules which users and teams should have which access to the virtual
cluster.
extraAccessRules
required object[] pro​access
required object[] pro​
Access to the virtual cluster object itself
access
required object[] pro​name
required string pro​
Name is an optional name that is used for this access rule
name
required string pro​verbs
required string[] pro​
Verbs is a list of Verbs that apply to ALL the ResourceKinds and AttributeRestrictions contained in this rule. VerbAll represents all kinds.
verbs
required string[] pro​subresources
required string[] pro​
Subresources defines the sub resources that are allowed by this access rule
subresources
required string[] pro​users
required string[] pro​
Users specifies which users should be able to access this secret with the aforementioned verbs
users
required string[] pro​teams
required string[] pro​
Teams specifies which teams should be able to access this secret with the aforementioned verbs
teams
required string[] pro​networkPeer
required boolean pro​
NetworkPeer specifies if the cluster is connected via tailscale.
networkPeer
required boolean pro​external
required boolean pro​
External specifies if the virtual cluster is managed by the platform agent or externally.
external
required boolean pro​status
required object pro​
status
required object pro​phase
required string pro​
Phase describes the current phase the virtual cluster instance is in
phase
required string pro​reason
required string pro​
Reason describes the reason in machine-readable form why the cluster is in the current
phase
reason
required string pro​message
required string pro​
Message describes the reason in human-readable form why the cluster is in the current
phase
message
required string pro​serviceUID
required string pro​
ServiceUID is the service uid of the virtual cluster to uniquely identify it.
serviceUID
required string pro​deployHash
required string pro​
DeployHash is the hash of the last deployed values.
deployHash
required string pro​conditions
required object pro​
Conditions holds several conditions the virtual cluster might be in
conditions
required object pro​virtualClusterObjects
required object pro​
VirtualClusterObjects are the objects that were applied within the virtual cluster itself
virtualClusterObjects
required object pro​lastAppliedObjects
required string pro​
LastAppliedObjects holds the status for the objects that were applied
lastAppliedObjects
required string pro​charts
required object[] pro​
Charts are the charts that were applied
charts
required object[] pro​apps
required object[] pro​
Apps are the apps that were applied
apps
required object[] pro​name
required string pro​
Name of the target app
name
required string pro​namespace
required string pro​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string pro​releaseName
required string pro​
ReleaseName is the name of the app release
releaseName
required string pro​version
required string pro​
Version of the app
version
required string pro​parameters
required string pro​
Parameters to use for the app
parameters
required string pro​spaceObjects
required object pro​
SpaceObjects are the objects that were applied within the virtual cluster space
spaceObjects
required object pro​lastAppliedObjects
required string pro​
LastAppliedObjects holds the status for the objects that were applied
lastAppliedObjects
required string pro​charts
required object[] pro​
Charts are the charts that were applied
charts
required object[] pro​apps
required object[] pro​
Apps are the apps that were applied
apps
required object[] pro​name
required string pro​
Name of the target app
name
required string pro​namespace
required string pro​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string pro​releaseName
required string pro​
ReleaseName is the name of the app release
releaseName
required string pro​version
required string pro​
Version of the app
version
required string pro​parameters
required string pro​
Parameters to use for the app
parameters
required string pro​virtualCluster
required object pro​
VirtualCluster is the template rendered with all the parameters
virtualCluster
required object pro​metadata
required object pro​
metadata
required object pro​instanceTemplate
required object pro​
InstanceTemplate holds the virtual cluster instance template
instanceTemplate
required object pro​apps
required object[] pro​
Apps specifies the apps that should get deployed by this template
apps
required object[] pro​name
required string pro​
Name of the target app
name
required string pro​namespace
required string pro​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string pro​releaseName
required string pro​
ReleaseName is the name of the app release
releaseName
required string pro​version
required string pro​
Version of the app
version
required string pro​parameters
required string pro​
Parameters to use for the app
parameters
required string pro​charts
required object[] pro​
Charts are helm charts that should get deployed
charts
required object[] pro​name
required string pro​
Name is the chart name in the repository
name
required string pro​version
required string pro​
Version is the chart version in the repository
version
required string pro​repoURL
required string pro​
RepoURL is the repo url where the chart can be found
repoURL
required string pro​username
required string pro​
The username that is required for this repository
username
required string pro​usernameRef
required object pro​
The username that is required for this repository
usernameRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​password
required string pro​
The password that is required for this repository
password
required string pro​passwordRef
required object pro​
The password that is required for this repository
passwordRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​insecureSkipTlsVerify
required boolean pro​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean pro​releaseName
required string pro​
ReleaseName is the preferred release name of the app
releaseName
required string pro​releaseNamespace
required string pro​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string pro​values
required string pro​
Values are the values that should get passed to the chart
values
required string pro​wait
required boolean pro​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean pro​timeout
required string pro​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string pro​objects
required string pro​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster
objects
required string pro​access
required object pro​
Access defines the access of users and teams to the virtual cluster.
access
required object pro​defaultClusterRole
required string pro​
Specifies which cluster role should get applied to users or teams that do not
match a rule below.
defaultClusterRole
required string pro​rules
required object[] pro​
Rules defines which users and teams should have which access to the virtual
cluster. If no rule matches an authenticated incoming user, the user will get cluster admin
access.
rules
required object[] pro​pro
required object pro​
Pro defines the pro settings for the virtual cluster
pro
required object pro​enabled
required boolean pro​
Enabled defines if the virtual cluster is a pro cluster or not
enabled
required boolean pro​helmRelease
required object pro​
HelmRelease is the helm release configuration for the virtual cluster.
helmRelease
required object pro​chart
required object pro​
infos about what chart to deploy
chart
required object pro​name
required string pro​
the name of the helm chart
name
required string pro​repo
required string pro​
the repo of the helm chart
repo
required string pro​username
required string pro​
The username that is required for this repository
username
required string pro​password
required string pro​
The password that is required for this repository
password
required string pro​version
required string pro​
the version of the helm chart to use
version
required string pro​values
required string pro​
the values for the given chart
values
required string pro​accessPoint
required object pro​
AccessPoint defines settings to expose the virtual cluster directly via an ingress rather than
through the (default) Loft proxy
accessPoint
required object pro​ingress
required object pro​
Ingress defines virtual cluster access via ingress
ingress
required object pro​enabled
required boolean pro​
Enabled defines if the virtual cluster access point (via ingress) is enabled or not; requires
the connected cluster to have the loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.
enabled
required boolean pro​loft.sh/ingress-suffix
annotation set to define the domain
name suffix used for the ingress.forwardToken
required boolean pro​
ForwardToken signals the proxy to pass through the used token to the virtual Kubernetes
api server and do a TokenReview there.
forwardToken
required boolean pro​spaceTemplate
required object pro​
SpaceTemplate holds the space template
spaceTemplate
required object pro​metadata
required object pro​
metadata
required object pro​objects
required string pro​
Objects are Kubernetes style yamls that should get deployed into the virtual cluster namespace
objects
required string pro​charts
required object[] pro​
Charts are helm charts that should get deployed
charts
required object[] pro​name
required string pro​
Name is the chart name in the repository
name
required string pro​version
required string pro​
Version is the chart version in the repository
version
required string pro​repoURL
required string pro​
RepoURL is the repo url where the chart can be found
repoURL
required string pro​username
required string pro​
The username that is required for this repository
username
required string pro​usernameRef
required object pro​
The username that is required for this repository
usernameRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​password
required string pro​
The password that is required for this repository
password
required string pro​passwordRef
required object pro​
The password that is required for this repository
passwordRef
required object pro​projectSecretRef
required object pro​
ProjectSecretRef holds the reference to a project secret
projectSecretRef
required object pro​insecureSkipTlsVerify
required boolean pro​
If tls certificate checks for the chart download should be skipped
insecureSkipTlsVerify
required boolean pro​releaseName
required string pro​
ReleaseName is the preferred release name of the app
releaseName
required string pro​releaseNamespace
required string pro​
ReleaseNamespace is the preferred release namespace of the app
releaseNamespace
required string pro​values
required string pro​
Values are the values that should get passed to the chart
values
required string pro​wait
required boolean pro​
Wait determines if Loft should wait during deploy for the app to become ready
wait
required boolean pro​timeout
required string pro​
Timeout is the time to wait for any individual Kubernetes operation (like Jobs for hooks) (default 5m0s)
timeout
required string pro​apps
required object[] pro​
Apps specifies the apps that should get deployed by this template
apps
required object[] pro​name
required string pro​
Name of the target app
name
required string pro​namespace
required string pro​
Namespace specifies in which target namespace the app should
get deployed in
namespace
required string pro​releaseName
required string pro​
ReleaseName is the name of the app release
releaseName
required string pro​version
required string pro​
Version of the app
version
required string pro​parameters
required string pro​
Parameters to use for the app
parameters
required string pro​ignoreReconciliation
required boolean pro​
IgnoreReconciliation tells the controller to ignore reconciliation for this instance -- this
is primarily used when migrating virtual cluster instances from project to project; this
prevents a situation where there are two virtual cluster instances representing the same
virtual cluster which could cause issues with concurrent reconciliations of the same object.
Once the virtual cluster instance has been cloned and placed into the new project, this
(the "old") virtual cluster instance can safely be deleted.
ignoreReconciliation
required boolean pro​Retrieve: Virtual Clusters​
You can either use curl or kubectl to retrieve Virtual Clusters.
- kubectl
- curl
Retrieve a list of Virtual Clusters​
Run the following command to list all Virtual Clusters in project my-project
:
kubectl get virtualclusterinstances.management.loft.sh -n loft-p-my-project -o yaml
Retrieve a single Virtual Cluster by name​
Run the following kubectl command to get Virtual Cluster my-virtual-cluster
in project my-project
:
kubectl get virtualclusterinstances.management.loft.sh my-virtual-cluster -n loft-p-my-project -o yaml
Retrieve a list of Virtual Clusters​
Run the following curl command to list all Virtual Clusters in project my-project
:
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/namespaces/loft-p-my-project/virtualclusterinstances" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Get a single Virtual Cluster by name​
Run the following curl command to get Virtual Cluster my-virtual-cluster
in project my-project
:
# Exchange my-virtual-cluster in the url below with the name of the Virtual Cluster
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/namespaces/loft-p-my-project/virtualclusterinstances/my-virtual-cluster" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Create: Virtual Cluster​
You can either use curl or kubectl to create a new Virtual Cluster.
Make sure to set the project in the metadata.namespace
field you want to create the Virtual Cluster in. If your project has the id my-project
, the corresponding namespace would be loft-p-my-project
.
- kubectl
- curl
Create a file object.yaml
with the following contents:
apiVersion: management.loft.sh/v1
kind: VirtualClusterInstance
metadata:
creationTimestamp: null
name: my-virtual-cluster
namespace: loft-p-my-project
spec:
clusterRef: {}
displayName: my-display-name
owner:
user: my-user
parameters: 'my-parameter: my-value'
templateRef:
name: my-virtual-cluster-template
status: {}
Then create the Virtual Cluster my-virtual-cluster
in project my-project
with:
kubectl create -f object.yaml -n loft-p-my-project
Create a file object.yaml
with the following contents:
apiVersion: management.loft.sh/v1
kind: VirtualClusterInstance
metadata:
creationTimestamp: null
name: my-virtual-cluster
namespace: loft-p-my-project
spec:
clusterRef: {}
displayName: my-display-name
owner:
user: my-user
parameters: 'my-parameter: my-value'
templateRef:
name: my-virtual-cluster-template
status: {}
Run the following curl command to create a new Virtual Cluster my-virtual-cluster
in project my-project
:
curl -s -X POST --insecure \
"https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/namespaces/loft-p-my-project/virtualclusterinstances" \
--data-binary "$(cat object.yaml)" \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY"
Update: Virtual Cluster​
You can either use curl or kubectl to update Virtual Clusters.
- kubectl
- curl
Update Virtual Cluster​
Run the following command to update Virtual Cluster my-virtual-cluster
in project my-project
:
kubectl edit virtualclusterinstances.management.loft.sh my-virtual-cluster -n loft-p-my-project
Then edit the object and upon save, kubectl will update the resource.
Patch Virtual Cluster​
Patching a resource is useful if you want to generically exchange only a small portion of the object instead of retrieving the whole object first and then modifying it. To learn more about patches in Kubernetes, please take a look at the official docs.
Run the following kubectl command to add a new annotation my-annotation: my-value
to the Virtual Cluster my-virtual-cluster
in project my-project
via a patch:
kubectl patch virtualclusterinstances.management.loft.sh my-virtual-cluster -n loft-p-my-project \
--type json \
-p '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'
Update Virtual Cluster​
First retrieve the current object into a file object.yaml
. This could look like:
apiVersion: management.loft.sh/v1
kind: VirtualClusterInstance
metadata:
creationTimestamp: "2023-04-03T00:00:00Z"
generation: 12
name: my-virtual-cluster
namespace: loft-p-my-project
resourceVersion: "66325905"
uid: af5f9f0f-8ab9-4b4b-a595-a95a5921f3c2
spec:
clusterRef: {}
displayName: my-display-name
owner:
user: my-user
parameters: 'my-parameter: my-value'
templateRef:
name: my-virtual-cluster-template
status: {}
Run the following curl command to update a single Virtual Cluster my-virtual-cluster
in project my-project
:
# Replace the my-virtual-cluster in the url below with the name of the Virtual Cluster you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/namespaces/loft-p-my-project/virtualclusterinstances/my-virtual-cluster" \
-X PUT --insecure \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY" \
--data-binary "$(cat object.yaml)"
Patch Virtual Cluster​
Patching a resource is useful if you want to generically exchange only a small portion of the object instead of retrieving the whole object first and then modifying it. To learn more about patches in Kubernetes, please take a look at the official docs.
Run the following curl command to add a new annotation my-annotation: my-value
to the Virtual Cluster my-virtual-cluster
in project my-project
via a patch:
# Replace the my-virtual-cluster in the url below with the name of the Virtual Cluster you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/namespaces/loft-p-my-project/virtualclusterinstances/my-virtual-cluster" \
-X PATCH --insecure \
-H "Content-Type: application/json-patch+json" \
-H "Authorization: Bearer $ACCESS_KEY" \
--data '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'
Delete: Virtual Cluster​
You can either use curl or kubectl to delete Virtual Clusters.
- kubectl
- curl
Run the following command to delete Virtual Cluster my-virtual-cluster
in project my-project
:
kubectl delete virtualclusterinstances.management.loft.sh my-virtual-cluster -n loft-p-my-project
Run the following curl command to delete Virtual Cluster my-virtual-cluster
in project my-project
:
# Replace the my-virtual-cluster in the url below with the name of the Virtual Cluster you want to delete
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/namespaces/loft-p-my-project/virtualclusterinstances/my-virtual-cluster" \
-X DELETE --insecure \
-H "Authorization: Bearer $ACCESS_KEY"