types

Documentation

Index

• type Capp
• type CappList
• type CappNamespaceUri
• type CappRevision
• type CappRevisionList
• type CappRevisionNamespaceUri
• type CappRevisionQuery
• type CappRevisionUri
• type CappState
• type CappStateResponse
• type CappSummary
• type CappUri
• type ConfigMap
• type ConfigMapUri
• type Container
• type ContainerRequestUri
• type CreateCapp
• type CreateCappQuery
• type CreateMetadata
• type CreateSecretRequest
• type CreateSecretResponse
• type CreateServiceAccountRequest
• type CreateTokenQuery
• type Credentials
• type DNS
• type DeleteSecretResponse
• type DeleteUserResponse
• type ErrorResponse
• type GetCappQuery
• type GetCappStateResponse
• type GetContainersResponse
• type GetDNSResponse
• type GetPodsResponse
• type GetSecretResponse
• type GetSecretsResponse
• type KeyValue
• type List
• type ListMetadata
• type LoginOutput
• type MessageResponse
• type Metadata
• type Namespace
• type NamespaceList
• type NamespaceUri
• type PaginationParams
• type Pod
• type PodRequestUri
• type Secret
• type SecretNamespaceUriRequest
• type SecretUriRequest
• type ServiceAccount
• type ServiceAccountOutput
• type ServiceAccountRequestUri
• type StartTerminalBody
• type StartTerminalResponse
• type StartTerminalUri
• type TokenRequestResponse
• type TokenResponse
• type UpdateCapp
• type UpdateSecretRequest
• type UpdateSecretResponse
• type UpdateUserData
• type User
• type UserIdentifier
• type UserInput
• type UserRole
• type UsersOutput

Types

type Capp

type Capp struct {
	Metadata    Metadata                `json:"metadata" binding:"required"`
	Annotations []KeyValue              `json:"annotations"`
	Labels      []KeyValue              `json:"labels"`
	Spec        cappv1alpha1.CappSpec   `json:"spec" binding:"required"`
	Status      cappv1alpha1.CappStatus `json:"status" binding:"required"`
}

type CappList

type CappList struct {
	Capps []CappSummary `json:"capps"`
	ListMetadata
}

type CappNamespaceUri

type CappNamespaceUri struct {
	NamespaceName string `uri:"namespaceName" binding:"required"`
}

type CappRevision

type CappRevision struct {
	Metadata    Metadata                        `json:"metadata" binding:"required"`
	Annotations []KeyValue                      `json:"annotations" binding:"required"`
	Labels      []KeyValue                      `json:"labels" binding:"required"`
	Spec        cappv1alpha1.CappRevisionSpec   `json:"spec" binding:"required"`
	Status      cappv1alpha1.CappRevisionStatus `json:"status" binding:"required"`
}

type CappRevisionList

type CappRevisionList struct {
	CappRevisions []string `json:"capprevisions"`
	ListMetadata
}

type CappRevisionNamespaceUri

type CappRevisionNamespaceUri struct {
	ClusterName   string `uri:"clusterName" json:"clusterName"`
	NamespaceName string `uri:"namespaceName" json:"namespaceName" binding:"required"`
	CappName      string `uri:"cappName" json:"cappName"`
}

type CappRevisionQuery

type CappRevisionQuery struct {
	LabelSelector string `form:"labelSelector"`
}

type CappRevisionUri

type CappRevisionUri struct {
	NamespaceName    string `uri:"namespaceName" binding:"required"`
	CappRevisionName string `uri:"cappRevisionName" binding:"required"`
	CappName         string `uri:"cappName" json:"cappName"`
}

type CappState

type CappState struct {
	State string `json:"state" binding:"required,oneof=enabled disabled"`
}

type CappStateResponse

type CappStateResponse struct {
	Name  string `json:"name"`
	State string `json:"state" binding:"oneof=enabled disabled"`
}

type CappSummary

type CappSummary struct {
	Name   string   `json:"name"`
	URL    string   `json:"url"`
	Images []string `json:"images"`
}

type CappUri

type CappUri struct {
	NamespaceName string `uri:"namespaceName" binding:"required"`
	CappName      string `uri:"cappName" binding:"required"`
}

type ConfigMap

type ConfigMap struct {
	Data []KeyValue `json:"data"`
}

type ConfigMapUri

type ConfigMapUri struct {
	NamespaceName string `uri:"namespaceName" json:"namespaceName" binding:"required"`
	ConfigMapName string `uri:"configMapName" json:"configMapName" binding:"required"`
}

type Container

type Container struct {
	ContainerName string `json:"containerName"`
}

type ContainerRequestUri

type ContainerRequestUri struct {
	NamespaceName string `uri:"namespaceName" json:"namespaceName" binding:"required"`
	PodName       string `uri:"podName" json:"podName" binding:"required"`
}

type CreateCapp

type CreateCapp struct {
	Metadata    CreateMetadata        `json:"metadata" binding:"required"`
	Annotations []KeyValue            `json:"annotations"`
	Labels      []KeyValue            `json:"labels"`
	Spec        cappv1alpha1.CappSpec `json:"spec" binding:"required"`
}

type CreateCappQuery

type CreateCappQuery struct {
	Environment string `form:"environment" json:"environment"`
	Region      string `form:"region" json:"region"`
}

type CreateMetadata

type CreateMetadata struct {
	Name string `json:"name" binding:"required"`
}

type CreateSecretRequest

type CreateSecretRequest struct {
	Type       string     `json:"type" binding:"required,oneof=tls opaque"`
	SecretName string     `json:"secretName" binding:"required"`
	Cert       string     `json:"cert"`
	Key        string     `json:"key"`
	Data       []KeyValue `json:"data"`
}

type CreateSecretResponse

type CreateSecretResponse struct {
	Type          string `json:"type"`
	SecretName    string `json:"secretName"`
	NamespaceName string `json:"namespaceName"`
}

type CreateServiceAccountRequest

type CreateServiceAccountRequest ServiceAccountRequestUri

type CreateTokenQuery

type CreateTokenQuery struct {
	ExpirationSeconds string `form:"expirationSeconds" json:"expirationSeconds"`
}

type Credentials

type Credentials struct {
	Username string `json:"username" binding:"required"`
	Password string `json:"password" binding:"required"`
}

type DNS

type DNS struct {
	Status corev1.ConditionStatus `json:"status"`
	Name   string                 `json:"name"`
}

type DeleteSecretResponse

type DeleteSecretResponse struct {
	Message string `json:"message"`
}

type DeleteUserResponse

type DeleteUserResponse struct {
	Message string `json:"message"`
}

type ErrorResponse

type ErrorResponse struct {
	Error  string `json:"error"`
	Reason string `json:"reason"`
}

type GetCappQuery

type GetCappQuery struct {
	LabelSelector string `form:"labelSelector" json:"labelSelector"`
}

type GetCappStateResponse

type GetCappStateResponse struct {
	LastCreatedRevision string `json:"lastCreatedRevision"`
	LastReadyRevision   string `json:"lastReadyRevision"`
	State               string `json:"state" binding:"required,oneof=enabled disabled"`
}

type GetContainersResponse

type GetContainersResponse struct {
	Containers []Container `json:"containers"`
	ListMetadata
}

type GetDNSResponse

type GetDNSResponse struct {
	Records []DNS `json:"records"`
}

type GetPodsResponse

type GetPodsResponse struct {
	Pods []Pod `json:"pods"`
	ListMetadata
}

type GetSecretResponse

type GetSecretResponse struct {
	Id         string     `json:"id"`
	Type       string     `json:"type"`
	SecretName string     `json:"secretName"`
	Data       []KeyValue `json:"data"`
}

type GetSecretsResponse

type GetSecretsResponse struct {
	Secrets []Secret `json:"secrets"`
	ListMetadata
}

type KeyValue

type KeyValue struct {
	Key   string `json:"key" binding:"required"`
	Value string `json:"value" binding:"required"`
}

type List

type List[T any] struct {
	metav1.TypeMeta `json:",inline"`
	// Standard list metadata.
	// +optional
	metav1.ListMeta `json:"metadata,omitempty" protobuf:"bytes,1,opt,name=metadata"`

	// Items is a list of objects.
	Items []T `json:"items" protobuf:"bytes,2,rep,name=items"`
}

type ListMetadata

type ListMetadata struct {
	Count int `json:"count"`
}

type LoginOutput

type LoginOutput struct {
	Token string `json:"token"`
}

type MessageResponse

type MessageResponse struct {
	Message string `json:"message"`
}

type Metadata

type Metadata struct {
	Name              string `json:"name" binding:"required"`
	Namespace         string `json:"namespace"`
	CreationTimestamp string `json:"creationTimestamp"`
}

type Namespace

type Namespace struct {
	Name string `json:"name" binding:"required"`
}

type NamespaceList

type NamespaceList struct {
	Namespaces []Namespace `json:"namespaces"`
	ListMetadata
}

type NamespaceUri

type NamespaceUri struct {
	NamespaceName string `uri:"namespaceName" json:"namespaceName" binding:"required"`
}

type PaginationParams

type PaginationParams struct {
	Limit int `form:"limit,omitempty" json:"limit" binding:"min=0"`
	Page  int `form:"page,default=1,omitempty" json:"page" binding:"min=1"`
}

type Pod

type Pod struct {
	PodName string `json:"podName"`
}

type PodRequestUri

type PodRequestUri struct {
	NamespaceName string `uri:"namespaceName" json:"namespaceName" binding:"required"`
	CappName      string `uri:"cappName" json:"cappName" binding:"required"`
}

type Secret

type Secret struct {
	Type          string `json:"type"`
	SecretName    string `json:"secretName"`
	NamespaceName string `json:"namespaceName"`
}

type SecretNamespaceUriRequest

type SecretNamespaceUriRequest struct {
	NamespaceName string `uri:"namespaceName" binding:"required"`
}

type SecretUriRequest

type SecretUriRequest struct {
	NamespaceName string `uri:"namespaceName" json:"namespaceName" binding:"required"`
	SecretName    string `uri:"secretName" json:"secretName" binding:"required"`
}

type ServiceAccount

type ServiceAccount struct {
	Name  string `json:"name" binding:"required"`
	Token string `json:"token,omitempty"`
}

type ServiceAccountOutput

type ServiceAccountOutput struct {
	ServiceAccounts []string `json:"serviceAccounts"`
	ListMetadata
}

type ServiceAccountRequestUri

type ServiceAccountRequestUri struct {
	NamespaceName      string `uri:"namespaceName" json:"namespaceName" binding:"required"`
	ServiceAccountName string `uri:"serviceAccountName" json:"serviceAccountName" binding:"required"`
}

type StartTerminalBody

type StartTerminalBody struct {
	Shell string `json:"shell" binding:"required,oneof=bash sh powershell cmd"`
}

type StartTerminalResponse

type StartTerminalResponse struct {
	ID string `json:"id"`
}

StartTerminalResponse is sent by HandleStartTerminal. The ID is a random session id that binds the original REST request and the SockJS connection. Any client api in possession of this ID can hijack the terminal_utils session.

type StartTerminalUri

type StartTerminalUri struct {
	ClusterName   string `uri:"clusterName" json:"clusterName" binding:"required"`
	NamespaceName string `uri:"namespaceName" json:"namespaceName" binding:"required"`
	PodName       string `uri:"podName" json:"podName" binding:"required"`
	ContainerName string `uri:"containerName" json:"containerName" binding:"required"`
}

type TokenRequestResponse

type TokenRequestResponse struct {
	Token               string    `json:"token"`
	ExpirationTimestamp time.Time `json:"expirationTimestamp,omitempty"`
}

type TokenResponse

type TokenResponse struct {
	Token string `json:"token"`
}

type UpdateCapp

type UpdateCapp struct {
	Annotations []KeyValue            `json:"annotations"`
	Labels      []KeyValue            `json:"labels"`
	Spec        cappv1alpha1.CappSpec `json:"spec"`
}

type UpdateSecretRequest

type UpdateSecretRequest struct {
	Data []KeyValue `json:"data" binding:"required"`
}

type UpdateSecretResponse

type UpdateSecretResponse struct {
	Type          string     `json:"type"`
	SecretName    string     `json:"secretName"`
	NamespaceName string     `json:"namespaceName"`
	Data          []KeyValue `json:"data"`
}

type UpdateUserData

type UpdateUserData struct {
	Role string `json:"role" binding:"required,oneof=admin viewer contributor"`
}

type User

type User struct {
	Name string `json:"name" binding:"required"`
	Role string `json:"role" binding:"required,oneof=admin viewer contributor"`
}

type UserIdentifier

type UserIdentifier struct {
	UserName      string `json:"userName" uri:"userName" binding:"required"`
	NamespaceName string `json:"namespaceName" binding:"required" uri:"namespaceName"`
}

type UserInput

type UserInput struct {
	Namespace string `json:"namespace" binding:"required,oneof=admin viewer contributor"`
	User
}

type UserRole

type UserRole string

const (
	AdminRole       UserRole = "admin"
	ContributorRole UserRole = "contributor"
	ViewerRole      UserRole = "viewer"
)

type UsersOutput

type UsersOutput struct {
	Users []User `json:"users"`
	ListMetadata
}