Skip to main content

API and kubectl reference

All groups are version v1alpha1. kubectl explain <kind>.<path> --recursive shows every field.

API groups​

GroupProductKinds
iam.tapsicloud.comMembers and accessWorkspaceMembership, NamespaceMembership
oss.tapsicloud.comObject Storage (S3)S3Bucket, S3BucketClaim, S3BucketAccess
compute.tapsicloud.comCloud ServersVirtualMachine, PersistentVolumeClaim, PersistentVolume, SSHKey, CustomMachineImage + catalog
network.tapsicloud.comNetworkingVPC, Subnet, PrivateIP, PublicIPClaim, PublicIP, PublicSubnet
infra.tapsicloud.comPlacement and quotaWorkspaceProfile, Cluster
billing.tapsicloud.comBillingCustomer, Subscription, Invoice, CreditBucket, Payment, PublicPlan, VoucherRedemption, …

Everyday commands​

TaskCommand
Listkubectl get vms · kubectl get vpcs · kubectl get s3bucketclaims -A
Details with eventskubectl describe vm api-runner-01
Full objectkubectl get vm api-runner-01 -o yaml
What a field meanskubectl explain virtualmachines.spec.interfaces
Check without creatingkubectl apply -f machine.yaml --dry-run=server
Watch changeskubectl get vms -w
Namespace eventskubectl get events -n production --sort-by=.lastTimestamp

Why is it stuck?​

zsh
❯ kubectl get vm api-runner-01 -o jsonpath='{range .status.conditions[*]}{.type}={.status} {.reason}: {.message}{"\n"}{end}'

Duplicate names​

storageclasses, persistentvolumes and persistentvolumeclaims also exist in core Kubernetes. When ambiguous, use the qualified name: persistentvolumeclaims.compute.tapsicloud.com