Class K8SCluster

Implements

IK8SCluster

Constructors

constructor

new K8SCluster(__namedParameters: K8SClusterParams): K8SCluster
Parameters
- __namedParameters: K8SClusterParams
Returns K8SCluster
- Defined in packages/k8s/src/k8s.cluster.ts:48

Methods

createClusterCustomObject

createClusterCustomObject<CustomResource extends K8SCustomResource>(
__namedParameters: PersistClusterCustomObjectDTO<CustomResource>,
): Promise<void>
Type Parameters
- CustomResource extends K8SCustomResource
Parameters
- __namedParameters: PersistClusterCustomObjectDTO<CustomResource>
Returns Promise<void>
Implementation of IK8SCluster.createClusterCustomObject
- Defined in packages/k8s/src/k8s.cluster.ts:252

createCustomResourceDefinition

createCustomResourceDefinition(body: V1CustomResourceDefinition): Promise<void>
Parameters
- body: V1CustomResourceDefinition
Returns Promise<void>
Implementation of IK8SCluster.createCustomResourceDefinition
- Defined in packages/k8s/src/k8s.cluster.ts:225

createDeployment

createDeployment(__namedParameters: CreateDeploymentDTO): Promise<void>
Parameters
- __namedParameters: CreateDeploymentDTO
Returns Promise<void>
Implementation of IK8SCluster.createDeployment
- Defined in packages/k8s/src/k8s.cluster.ts:89

createNamespace

createNamespace(name: string): Promise<void>
Parameters
- name: string
Returns Promise<void>
Implementation of IK8SCluster.createNamespace
- Defined in packages/k8s/src/k8s.cluster.ts:69

createRole

createRole(__namedParameters: CreateRoleDTO): Promise<void>
Parameters
- __namedParameters: CreateRoleDTO
Returns Promise<void>
Implementation of IK8SCluster.createRole
- Defined in packages/k8s/src/k8s.cluster.ts:169

createRoleBinding

createRoleBinding(__namedParameters: CreateRoleBindingDTO): Promise<void>
Parameters
- __namedParameters: CreateRoleBindingDTO
Returns Promise<void>
Implementation of IK8SCluster.createRoleBinding
- Defined in packages/k8s/src/k8s.cluster.ts:195

createService

createService(__namedParameters: CreateServiceDTO): Promise<void>
Parameters
- __namedParameters: CreateServiceDTO
Returns Promise<void>
Implementation of IK8SCluster.createService
- Defined in packages/k8s/src/k8s.cluster.ts:151

createServiceAccount

createServiceAccount(__namedParameters: CreateServiceAccountDTO): Promise<void>
Parameters
- __namedParameters: CreateServiceAccountDTO
Returns Promise<void>
Implementation of IK8SCluster.createServiceAccount
- Defined in packages/k8s/src/k8s.cluster.ts:113

createServiceAccountToken

createServiceAccountToken(
__namedParameters: CreateServiceAccountTokenDTO,
): Promise<void>
Parameters
- __namedParameters: CreateServiceAccountTokenDTO
Returns Promise<void>
Implementation of IK8SCluster.createServiceAccountToken
- Defined in packages/k8s/src/k8s.cluster.ts:130

deleteClusterCustomObject

deleteClusterCustomObject<CustomResource extends K8SCustomResource>(
__namedParameters: DeleteClusterCustomObjectDTO<CustomResource>,
): Promise<void>
Type Parameters
- CustomResource extends K8SCustomResource
Parameters
- __namedParameters: DeleteClusterCustomObjectDTO<CustomResource>
Returns Promise<void>
Implementation of IK8SCluster.deleteClusterCustomObject
- Defined in packages/k8s/src/k8s.cluster.ts:313

deleteDeployment

deleteDeployment(__namedParameters: DeleteComponentDTO): Promise<void>
Parameters
- __namedParameters: DeleteComponentDTO
Returns Promise<void>
Implementation of IK8SCluster.deleteDeployment
- Defined in packages/k8s/src/k8s.cluster.ts:96

deleteNamespace

deleteNamespace(namespace: string): Promise<void>
Parameters
- namespace: string
Returns Promise<void>
Implementation of IK8SCluster.deleteNamespace
- Defined in packages/k8s/src/k8s.cluster.ts:81

deleteService

deleteService(__namedParameters: DeleteComponentDTO): Promise<void>
Parameters
- __namedParameters: DeleteComponentDTO
Returns Promise<void>
Implementation of IK8SCluster.deleteService
- Defined in packages/k8s/src/k8s.cluster.ts:155

getAllClusterCustomObjectsFromResourceDefinition

getAllClusterCustomObjectsFromResourceDefinition<
CustomResource extends K8SCustomResource,
>(
__namedParameters: V1CustomResourceDefinition,
): Promise<CustomResource[]>
Type Parameters
- CustomResource extends K8SCustomResource
Parameters
- __namedParameters: V1CustomResourceDefinition
Returns Promise<CustomResource[]>
Implementation of IK8SCluster.getAllClusterCustomObjectsFromResourceDefinition
- Defined in packages/k8s/src/k8s.cluster.ts:233

getAllCustomResourceDefinitions

getAllCustomResourceDefinitions(): Promise<V1CustomResourceDefinition[]>
Returns Promise<V1CustomResourceDefinition[]>
Implementation of IK8SCluster.getAllCustomResourceDefinitions
- Defined in packages/k8s/src/k8s.cluster.ts:219

getAllNamespaces

getAllNamespaces(): Promise<V1Namespace[]>
Returns Promise<V1Namespace[]>
Implementation of IK8SCluster.getAllNamespaces
- Defined in packages/k8s/src/k8s.cluster.ts:58

getDeploymentsFromNamespace

getDeploymentsFromNamespace(namespace: string): Promise<V1Deployment[]>
Parameters
- namespace: string
Returns Promise<V1Deployment[]>
Implementation of IK8SCluster.getDeploymentsFromNamespace
- Defined in packages/k8s/src/k8s.cluster.ts:85

getRoleBindings

getRoleBindings(__namedParameters: GetRoleBindingsDTO): Promise<V1RoleBinding[]>
Parameters
- __namedParameters: GetRoleBindingsDTO
Returns Promise<V1RoleBinding[]>
Implementation of IK8SCluster.getRoleBindings
- Defined in packages/k8s/src/k8s.cluster.ts:187

getRoles

getRoles(__namedParameters: GetRolesDTO): Promise<V1Role[]>
Parameters
- __namedParameters: GetRolesDTO
Returns Promise<V1Role[]>
Implementation of IK8SCluster.getRoles
- Defined in packages/k8s/src/k8s.cluster.ts:163

getSecretsFromNamespace

getSecretsFromNamespace(namespace: string): Promise<V1Secret[]>
Parameters
- namespace: string
Returns Promise<V1Secret[]>
Implementation of IK8SCluster.getSecretsFromNamespace
- Defined in packages/k8s/src/k8s.cluster.ts:159

getServiceAccountsFromNamespace

getServiceAccountsFromNamespace(namespace: string): Promise<V1ServiceAccount[]>
Parameters
- namespace: string
Returns Promise<V1ServiceAccount[]>
Implementation of IK8SCluster.getServiceAccountsFromNamespace
- Defined in packages/k8s/src/k8s.cluster.ts:107

getServicesFromNamespace

getServicesFromNamespace(namespace: string): Promise<V1Service[]>
Parameters
- namespace: string
Returns Promise<V1Service[]>
Implementation of IK8SCluster.getServicesFromNamespace
- Defined in packages/k8s/src/k8s.cluster.ts:103

isNamespacePersisted

isNamespacePersisted(name: string): Promise<boolean>
Parameters
- name: string
Returns Promise<boolean>
Implementation of IK8SCluster.isNamespacePersisted
- Defined in packages/k8s/src/k8s.cluster.ts:62

patchClusterCustomObject

patchClusterCustomObject<CustomResource extends K8SCustomResource>(
__namedParameters: PersistClusterCustomObjectDTO<CustomResource>,
): Promise<void>
Type Parameters
- CustomResource extends K8SCustomResource
Parameters
- __namedParameters: PersistClusterCustomObjectDTO<CustomResource>
Returns Promise<void>
Implementation of IK8SCluster.patchClusterCustomObject
- Defined in packages/k8s/src/k8s.cluster.ts:279

Class K8SCluster

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns K8SCluster

Methods

createClusterCustomObject

Type Parameters

Parameters

Returns Promise<void>

createCustomResourceDefinition

Parameters

Returns Promise<void>

createDeployment

Parameters

Returns Promise<void>

createNamespace

Parameters

Returns Promise<void>

createRole

Parameters

Returns Promise<void>

createRoleBinding

Parameters

Returns Promise<void>

createService

Parameters

Returns Promise<void>

createServiceAccount

Parameters

Returns Promise<void>

createServiceAccountToken

Parameters

Returns Promise<void>

deleteClusterCustomObject

Type Parameters

Parameters

Returns Promise<void>

deleteDeployment

Parameters

Returns Promise<void>

deleteNamespace

Parameters

Returns Promise<void>

deleteService

Parameters

Returns Promise<void>

getAllClusterCustomObjectsFromResourceDefinition

Type Parameters

Parameters

Returns Promise<CustomResource[]>

getAllCustomResourceDefinitions

Returns Promise<V1CustomResourceDefinition[]>

getAllNamespaces

Returns Promise<V1Namespace[]>

getDeploymentsFromNamespace

Parameters

Returns Promise<V1Deployment[]>

getRoleBindings

Parameters

Returns Promise<V1RoleBinding[]>

getRoles

Parameters

Returns Promise<V1Role[]>

getSecretsFromNamespace

Parameters

Returns Promise<V1Secret[]>

getServiceAccountsFromNamespace

Parameters

Returns Promise<V1ServiceAccount[]>

getServicesFromNamespace

Parameters

Returns Promise<V1Service[]>

isNamespacePersisted

Parameters

Returns Promise<boolean>