Team
Teams are composed of multiple users and define a way to manage cluster access or other objects for multiple users at once. You can assign users automatically to teams by their groups, which can be synced from an authentication provider. Teams can also access Loft through their own access keys and own spaces or other objects.
Example Team​
An example Team:
apiVersion: management.loft.sh/v1
kind: Team
metadata:
creationTimestamp: null
name: my-team
spec:
clusterRoles:
- name: loft-management-admin
description: All users in this team have full admin access to all clusters
displayName: Global Admins
groups:
- loft:admins
username: loftadmins
status: {}
Team 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​
The display name shown in the UI
displayName
required string pro​description
required string pro​
Description describes a cluster access object
description
required string pro​owner
required object pro​
Owner holds the owner of this object
owner
required object pro​username
required string pro​
The username of the team that will be used for identification and docker registry namespace
username
required string pro​users
required string[] pro​
The loft users that belong to a team
users
required string[] pro​groups
required string[] pro​
The groups defined in a token that belong to a team
groups
required string[] pro​imagePullSecrets
required object[] pro​
ImagePullSecrets holds secret references to image pull
secrets the team has access to.
imagePullSecrets
required object[] pro​clusterRoles
required object[] pro​
ClusterRoles define the cluster roles that the users should have assigned in the cluster.
clusterRoles
required object[] pro​name
required string pro​
Name is the cluster role to assign
name
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​status
required object pro​
status
required object pro​Retrieve: Teams​
You can either use curl or kubectl to retrieve Teams.
- kubectl
- curl
Retrieve a list of Teams​
Run the following command to list all Teams:
kubectl get teams.management.loft.sh -o yaml
Retrieve a single Team by name​
Run the following kubectl command to get Team my-team
:
kubectl get teams.management.loft.sh my-team -o yaml
Retrieve a list of Teams​
Run the following curl command to list all Teams:
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/teams" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Get a single Team by name​
Run the following curl command to get Team my-team
:
# Exchange my-team in the url below with the name of the Team
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/teams/my-team" \
-X GET --insecure \
-H "Authorization: Bearer $ACCESS_KEY"
Create: Team​
You can either use curl or kubectl to create a new Team.
- kubectl
- curl
Create a file object.yaml
with the following contents:
apiVersion: management.loft.sh/v1
kind: Team
metadata:
creationTimestamp: null
name: my-team
spec:
clusterRoles:
- name: loft-management-admin
description: All users in this team have full admin access to all clusters
displayName: Global Admins
groups:
- loft:admins
username: loftadmins
status: {}
Then create the Team my-team
with:
kubectl create -f object.yaml
Create a file object.yaml
with the following contents:
apiVersion: management.loft.sh/v1
kind: Team
metadata:
creationTimestamp: null
name: my-team
spec:
clusterRoles:
- name: loft-management-admin
description: All users in this team have full admin access to all clusters
displayName: Global Admins
groups:
- loft:admins
username: loftadmins
status: {}
Run the following curl command to create a new Team my-team
:
curl -s -X POST --insecure \
"https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/teams" \
--data-binary "$(cat object.yaml)" \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY"
Update: Team​
You can either use curl or kubectl to update Teams.
- kubectl
- curl
Update Team​
Run the following command to update Team my-team
:
kubectl edit teams.management.loft.sh my-team
Then edit the object and upon save, kubectl will update the resource.
Patch Team​
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 Team my-team
via a patch:
kubectl patch teams.management.loft.sh my-team \
--type json \
-p '[{"op": "add", "path": "/metadata/annotations/my-annotation", "value": "my-value"}]'
Update Team​
First retrieve the current object into a file object.yaml
. This could look like:
apiVersion: management.loft.sh/v1
kind: Team
metadata:
creationTimestamp: "2023-04-03T00:00:00Z"
generation: 12
name: my-team
resourceVersion: "66325905"
uid: af5f9f0f-8ab9-4b4b-a595-a95a5921f3c2
spec:
clusterRoles:
- name: loft-management-admin
description: All users in this team have full admin access to all clusters
displayName: Global Admins
groups:
- loft:admins
username: loftadmins
status: {}
Run the following curl command to update a single Team my-team
:
# Replace the my-team in the url below with the name of the Team you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/teams/my-team" \
-X PUT --insecure \
-H "Content-Type: application/yaml" \
-H "Authorization: Bearer $ACCESS_KEY" \
--data-binary "$(cat object.yaml)"
Patch Team​
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 Team my-team
via a patch:
# Replace the my-team in the url below with the name of the Team you want to update
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/teams/my-team" \
-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: Team​
You can either use curl or kubectl to delete Teams.
- kubectl
- curl
Run the following command to delete Team my-team
:
kubectl delete teams.management.loft.sh my-team
Run the following curl command to delete Team my-team
:
# Replace the my-team in the url below with the name of the Team you want to delete
curl -s "https://$LOFT_DOMAIN/kubernetes/management/apis/management.loft.sh/v1/teams/my-team" \
-X DELETE --insecure \
-H "Authorization: Bearer $ACCESS_KEY"