Project
Projects are used to group virtual clusters and spaces together.
Example Project​
An example Project:
apiVersion: management.loft.sh/v1
kind: Project
metadata:
creationTimestamp: null
name: my-project
spec:
allowedClusters:
- name: my-allowed-cluster
allowedTemplates:
- kind: VirtualClusterTemplate
name: '*'
- kind: SpaceTemplate
name: '*'
members:
- clusterRole: project-admin
group: storage.loft.sh
kind: User
name: admin
- clusterRole: project-user
group: storage.loft.sh
kind: Team
name: my-team
quotas: {}
requireTemplate: {}
vault: {}
status: {}
Project 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 an app
description
required string pro​owner
required object pro​
Owner holds the owner of this object
owner
required object pro​quotas
required object pro​
Quotas define the quotas inside the project
quotas
required object pro​allowedClusters
required object[] pro​
AllowedClusters are target clusters that are allowed to target with
environments.
allowedClusters
required object[] pro​name
required string pro​
Name is the name of the cluster that is allowed to create an environment in.
name
required string pro​allowedRunners
required object[] pro​
AllowedRunners are target runners that are allowed to target with
DevPod environments.
allowedRunners
required object[] pro​name
required string pro​
Name is the name of the runner that is allowed to create an environment in.
name
required string pro​allowedTemplates
required object[] pro​
AllowedTemplates are the templates that are allowed to use in this
project.
allowedTemplates
required object[] pro​kind
required string pro​
Kind of the template that is allowed. Currently only supports DevPodWorkspaceTemplate, VirtualClusterTemplate & SpaceTemplate
kind
required string pro​group
required string pro​
Group of the template that is allowed. Currently only supports storage.loft.sh
group
required string pro​name
required string pro​
Name of the template
name
required string pro​isDefault
required boolean pro​
IsDefault specifies if the template should be used as a default
isDefault
required boolean pro​requireTemplate
required object pro​
RequireTemplate configures if a template is required for instance creation.
requireTemplate
required object pro​disabled
required boolean pro​
If true, all users within the project will be allowed to create a new instance without a template.
By default, only admins are allowed to create a new instance without a template.
disabled
required boolean pro​members
required object[] pro​
Members are the users and teams that are part of this project
members
required object[] pro​kind
required string pro​
Kind is the kind of the member. Currently either User or Team
kind
required string pro​group
required string pro​
Group of the member. Currently only supports storage.loft.sh
group
required string pro​name
required string pro​
Name of the member
name
required string pro​clusterRole
required string pro​
ClusterRole is the assigned role for the above member
clusterRole
required string pro​access
required object[] pro​
Access holds the access rights for users and teams
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​namespacePattern
required object pro​
NamespacePattern specifies template patterns to use for creating each space or virtual cluster's namespace
namespacePattern
required object pro​argoCD
required object pro​
ArgoIntegration holds information about ArgoCD Integration
argoCD
required object pro​enabled
required boolean pro​
Enabled indicates if the ArgoCD Integration is enabled for the project -- this knob only
enables the syncing of virtualclusters, but does not enable SSO integration or project
creation (see subsequent spec sections!).
enabled
required boolean pro​cluster
required string pro​
Cluster defines the name of the cluster that ArgoCD is deployed into -- if not provided this
will default to 'loft-cluster'.
cluster
required string pro​virtualClusterInstance
required string pro​
VirtualClusterInstance defines the name of virtual cluster (instance) that ArgoCD is
deployed into. If provided, Cluster will be ignored and Loft will assume that ArgoCD is
running in the specified virtual cluster.
virtualClusterInstance
required string pro​namespace
required string pro​
Namespace defines the namespace in which ArgoCD is running in the cluster.
namespace
required string pro​sso
required object pro​
SSO defines single-sign-on related values for the ArgoCD Integration. Enabling SSO will allow
users to authenticate to ArgoCD via Loft.
sso
required object pro​enabled
required boolean pro​
Enabled indicates if the ArgoCD SSO Integration is enabled for this project. Enabling this
will cause Loft to configure SSO authentication via Loft in ArgoCD. If Projects are not
enabled, all users associated with this Project will be assigned either the 'read-only'
(default) role, or the roles set under the AssignedRoles field.
enabled
required boolean pro​host
required string pro​
Host defines the ArgoCD host address that will be used for OIDC authentication between loft
and ArgoCD. If not specified OIDC integration will be skipped, but virtual
clusters/spaces will
still be synced to ArgoCD.
host
required string pro​assignedRoles
required string[] pro​
AssignedRoles is a list of roles to assign for users who authenticate via Loft -- by default
this will be the read-only
role. If any roles are provided this will override the default
setting.
assignedRoles
required string[] pro​read-only
role. If any roles are provided this will override the default
setting.project
required object pro​
Project defines project related values for the ArgoCD Integration. Enabling Project
integration will cause Loft to generate and manage an ArgoCD appProject that corresponds to
the Loft Project.
project
required object pro​enabled
required boolean pro​
Enabled indicates if the ArgoCD Project Integration is enabled for this project. Enabling
this will cause Loft to create an appProject in ArgoCD that is associated with the Loft
Project. When Project integration is enabled Loft will override the default assigned role
set in the SSO integration spec.
enabled
required boolean pro​metadata
required object pro​
Metadata defines additional metadata to attach to the loft created project in ArgoCD.
metadata
required object pro​extraAnnotations
required object pro​
ExtraAnnotations are optional annotations that can be attached to the project in ArgoCD.
extraAnnotations
required object pro​extraLabels
required object pro​
ExtraLabels are optional labels that can be attached to the project in ArgoCD.
extraLabels
required object pro​description
required string pro​
Description to add to the ArgoCD project.
description
required string pro​sourceRepos
required string[] pro​
SourceRepos is a list of source repositories to attach/allow on the project, if not specified
will be "*" indicating all source repositories.
sourceRepos
required string[] pro​roles
required object[] pro​
Roles is a list of roles that should be attached to the ArgoCD project. If roles are provided
no loft default roles will be set. If no roles are provided and SSO is enabled, loft will
configure sane default values.
roles
required object[] pro​name
required string pro​
Name of the ArgoCD role to attach to the project.
name
required string pro​description
required string pro​
Description to add to the ArgoCD project.
description
required string pro​rules
required object[] pro​
Rules ist a list of policy rules to attach to the role.
rules
required object[] pro​action
required string pro​
Action is one of "*", "get", "create", "update", "delete", "sync", or "override".
action
required string pro​application
required string pro​
Application is the ArgoCD project/repository to apply the rule to.
application
required string pro​permission
required boolean pro​
Allow applies the "allow" permission to the rule, if allow is not set, the permission will
always be set to "deny".
permission
required boolean pro​groups
required string[] pro​
Groups is a list of OIDC group names to bind to the role.
groups
required string[] pro​vault
required object pro​
VaultIntegration holds information about Vault Integration
vault
required object pro​enabled
required boolean pro​
Enabled indicates if the Vault Integration is enabled for the project -- this knob only
enables the syncing of secrets to or from Vault, but does not setup Kubernetes authentication
methods or Kubernetes secrets engines for virtual clusters.
enabled
required boolean pro​address
required string pro​
Address defines the address of the Vault instance to use for this project.
Will default to the VAULT_ADDR
environment variable if not provided.
address
required string pro​VAULT_ADDR
environment variable if not provided.skipTLSVerify
required boolean pro​
SkipTLSVerify defines if TLS verification should be skipped when connecting to Vault.
skipTLSVerify
required boolean pro​namespace
required string pro​
Namespace defines the namespace to use when storing secrets in Vault.
namespace
required string pro​auth
required object pro​
Auth defines the authentication method to use for this project.
auth
required object pro​token
required string pro​
Token defines the token to use for authentication.
token
required string pro​tokenSecretRef
required object pro​
TokenSecretRef defines the Kubernetes secret to use for token authentication.
Will be used if token
is not provided.
Secret data should contain the token
key.
tokenSecretRef
required object pro​token
is not provided.token
key.name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string pro​
The key of the secret to select from. Must be a valid secret key.
key
required string pro​optional
required boolean pro​
Specify whether the Secret or its key must be defined
optional
required boolean pro​syncInterval
required string pro​
SyncInterval defines the interval at which to sync secrets from Vault.
Defaults to 1m.
See https://pkg.go.dev/time#ParseDuration for supported formats.
syncInterval
required string pro​1m.
See https://pkg.go.dev/time#ParseDuration for supported formats.rancher
required object pro​
RancherIntegration holds information about Rancher Integration
rancher
required object pro​enabled
required boolean pro​
Enabled indicates if the Rancher Project Integration is enabled for this project.
enabled
required boolean pro​projectRef
required object pro​
ProjectRef defines references to rancher project, required for syncMembers and syncVirtualClusters.syncMembers
projectRef
required object pro​importVirtualClusters
required object pro​
ImportVirtualClusters defines settings to import virtual clusters to Rancher on creation
importVirtualClusters
required object pro​roleMapping
required object pro​
RoleMapping indicates an optional role mapping from a rancher project role to a rancher cluster role. Map to an empty role to exclude users and groups with that role from
being synced.
roleMapping
required object pro​syncMembers
required object pro​
SyncMembers defines settings to sync Rancher project members to the loft project
syncMembers
required object pro​enabled
required boolean pro​
Enabled indicates whether to sync rancher project members to the loft project.
enabled
required boolean pro​roleMapping
required object pro​
RoleMapping indicates an optional role mapping from a rancher role to a loft role. Map to an empty role to exclude users and groups with that role from
being synced.
roleMapping
required object pro​devPod
required object pro​
DevPod holds DevPod specific configuration for project
devPod
required object pro​git
required object pro​
Git defines additional git related settings like credentials
git
required object pro​token
required string pro​
Token defines the token to use for authentication.
token
required string pro​tokenSecretRef
required object pro​
TokenSecretRef defines the project secret to use for token authentication.
Will be used if Token
is not provided.
tokenSecretRef
required object pro​Token
is not provided.name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string pro​
The key of the secret to select from. Must be a valid secret key.
key
required string pro​optional
required boolean pro​
Specify whether the Secret or its key must be defined
optional
required boolean pro​ssh
required object pro​
SSH defines additional ssh related settings like private keys, to be
specified as base64 encoded strings.
ssh
required object pro​token
required string pro​
Token defines the private ssh key to use for authentication,
this is a base64 encoded string.
token
required string pro​tokenSecretRef
required object pro​
TokenSecretRef defines the project secret to use as private ssh key for authentication.
Will be used if Token
is not provided.
tokenSecretRef
required object pro​Token
is not provided.name
required string pro​
Name of the referent.
This field is effectively required, but due to backwards compatibility is
allowed to be empty. Instances of this type with an empty value here are
almost certainly wrong.
TODO: Add other useful fields. apiVersion, kind, uid?
More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
TODO: Drop kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.
name
required string pro​kubebuilder:default
when controller-gen doesn't need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.key
required string pro​
The key of the secret to select from. Must be a valid secret key.
key
required string pro​optional
required boolean pro​
Specify whether the Secret or its key must be defined
optional
required boolean pro​fallbackImage
required string pro​
FallbackImage defines an image all workspace will fall back to if no devcontainer.json could be detected
fallbackImage
required string pro​status
required object pro​
status
required object pro​quotas
required object pro​
Quotas holds the quota status
quotas
required object pro​project
required object pro​
Project is the quota status for the whole project
project
required object pro​user
required object pro​
User is the quota status for each user / team. An example status
could look like this:
status:
quotas:
user:
limit:
pods: "10"
spaces: "5"
users:
admin:
used:
spaces: "3" # (- calculated in our apiserver
pods: "8" # (- the sum calculated from clusters
clusters:
cluster-1: # (- populated by agent from cluster-1
users:
admin:
pods: "3"
cluster-2:
users:
admin:
pods: "5"
user
required object pro​conditions
required object pro​
Conditions holds several conditions the project might be in
conditions
required object pro​Retrieve: Projects​
You can either use curl or kubectl to retrieve Projects.
- kubectl
- curl
Retrieve a list of Projects​
Run the following command to list all Projects:
kubectl get projects.management.loft.sh -o yaml
Retrieve a single Project by name​
Run the following kubectl command to get Project my-project
:
kubectl get projects.management.loft.sh my-project -o yaml
Retrieve a list of Projects​
Run the following curl command to list all Projects:
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/projects" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Get a single Project by name​
Run the following curl command to get Project my-project
:
# Exchange my-project in the url below with the name of the Project
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/projects/my-project" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Create: Project​
You can either use curl or kubectl to create a new Project.
- kubectl
- curl
Create a file object.yaml
with the following contents:
apiVersion: management.loft.sh/v1
kind: Project
metadata:
creationTimestamp: null
name: my-project
spec:
allowedClusters:
- name: my-allowed-cluster
allowedTemplates:
- kind: VirtualClusterTemplate
name: '*'
- kind: SpaceTemplate
name: '*'
members:
- clusterRole: project-admin
group: storage.loft.sh
kind: User
name: admin
- clusterRole: project-user
group: storage.loft.sh
kind: Team
name: my-team
quotas: {}
requireTemplate: {}
vault: {}
status: {}
Then create the Project my-project
with:
kubectl create -f object.yaml
Create a file object.yaml
with the following contents:
apiVersion: management.loft.sh/v1
kind: Project
metadata:
creationTimestamp: null
name: my-project
spec:
allowedClusters:
- name: my-allowed-cluster
allowedTemplates:
- kind: VirtualClusterTemplate
name: '*'
- kind: SpaceTemplate
name: '*'
members:
- clusterRole: project-admin
group: storage.loft.sh
kind: User
name: admin
- clusterRole: project-user
group: storage.loft.sh
kind: Team
name: my-team
quotas: {}
requireTemplate: {}
vault: {}
status: {}
Run the following curl command to create a new Project my-project
:
curl -s -X POST --insecure \
"https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/projects" \
--data-binary "$(cat object.yaml)" \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY"
Update: Project​
You can either use curl or kubectl to update Projects.
- kubectl
- curl
Update Project​
Run the following command to update Project my-project
:
kubectl edit projects.management.loft.sh my-project
Then edit the object and upon save, kubectl will update the resource.
Patch Project​
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 Project my-project
via a patch:
kubectl patch projects.management.loft.sh my-project \
--type json \
-p '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'
Update Project​
First retrieve the current object into a file object.yaml
. This could look like:
apiVersion: management.loft.sh/v1
kind: Project
metadata:
creationTimestamp: "2023-04-03T00:00:00Z"
generation: 12
name: my-project
resourceVersion: "66325905"
uid: af5f9f0f-8ab9-4b4b-a595-a95a5921f3c2
spec:
allowedClusters:
- name: my-allowed-cluster
allowedTemplates:
- kind: VirtualClusterTemplate
name: '*'
- kind: SpaceTemplate
name: '*'
members:
- clusterRole: project-admin
group: storage.loft.sh
kind: User
name: admin
- clusterRole: project-user
group: storage.loft.sh
kind: Team
name: my-team
quotas: {}
requireTemplate: {}
vault: {}
status: {}
Run the following curl command to update a single Project my-project
:
# Replace the my-project in the url below with the name of the Project you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/projects/my-project" \
-X PUT --insecure \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY" \
--data-binary "$(cat object.yaml)"
Patch Project​
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 Project my-project
via a patch:
# Replace the my-project in the url below with the name of the Project you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/projects/my-project" \
-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: Project​
You can either use curl or kubectl to delete Projects.
- kubectl
- curl
Run the following command to delete Project my-project
:
kubectl delete projects.management.loft.sh my-project
Run the following curl command to delete Project my-project
:
# Replace the my-project in the url below with the name of the Project you want to delete
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/projects/my-project" \
-X DELETE --insecure \
-H "Authorization: Bearer $ACCESS_KEY"