Stacks
Examples
GitHub
Contribute
Preparing search index...
@ask-ell/k8s
IK8SCluster
Interface IK8SCluster
interface
IK8SCluster
{
createClusterCustomObject
<
CustomResource
extends
K8SCustomResource
>
(
dto
:
PersistClusterCustomObjectDTO
<
CustomResource
>
,
)
:
Promise
<
void
>
;
createCustomResourceDefinition
(
dto
:
V1CustomResourceDefinition
,
)
:
Promise
<
void
>
;
createDeployment
(
dto
:
CreateDeploymentDTO
)
:
Promise
<
void
>
;
createNamespace
(
name
:
string
)
:
Promise
<
void
>
;
createRole
(
dto
:
CreateRoleDTO
)
:
Promise
<
void
>
;
createRoleBinding
(
dto
:
CreateRoleBindingDTO
)
:
Promise
<
void
>
;
createService
(
dto
:
CreateServiceDTO
)
:
Promise
<
void
>
;
createServiceAccount
(
dto
:
CreateServiceAccountDTO
)
:
Promise
<
void
>
;
createServiceAccountToken
(
dto
:
CreateServiceAccountTokenDTO
)
:
Promise
<
void
>
;
deleteClusterCustomObject
<
CustomResource
extends
K8SCustomResource
>
(
dto
:
DeleteClusterCustomObjectDTO
<
CustomResource
>
,
)
:
Promise
<
void
>
;
deleteDeployment
(
dto
:
DeleteComponentDTO
)
:
Promise
<
void
>
;
deleteNamespace
(
namespace
:
string
)
:
Promise
<
void
>
;
deleteService
(
dto
:
DeleteComponentDTO
)
:
Promise
<
void
>
;
getAllClusterCustomObjectsFromResourceDefinition
<
CustomResource
extends
K8SCustomResource
,
>
(
dto
:
V1CustomResourceDefinition
,
)
:
Promise
<
CustomResource
[]
>
;
getAllCustomResourceDefinitions
()
:
Promise
<
V1CustomResourceDefinition
[]
>
;
getAllNamespaces
()
:
Promise
<
V1Namespace
[]
>
;
getDeploymentsFromNamespace
(
namespace
:
string
)
:
Promise
<
V1Deployment
[]
>
;
getRoleBindings
(
dto
:
GetRoleBindingsDTO
)
:
Promise
<
V1RoleBinding
[]
>
;
getRoles
(
dto
:
GetRolesDTO
)
:
Promise
<
V1Role
[]
>
;
getSecretsFromNamespace
(
namespace
:
string
)
:
Promise
<
V1Secret
[]
>
;
getServiceAccountsFromNamespace
(
namespace
:
string
,
)
:
Promise
<
V1ServiceAccount
[]
>
;
getServicesFromNamespace
(
namespace
:
string
)
:
Promise
<
V1Service
[]
>
;
isNamespacePersisted
(
name
:
string
)
:
Promise
<
boolean
>
;
patchClusterCustomObject
<
CustomResource
extends
K8SCustomResource
>
(
dto
:
PersistClusterCustomObjectDTO
<
CustomResource
>
,
)
:
Promise
<
void
>
;
}
Implemented by
K8SCluster
Index
Methods
create
Cluster
Custom
Object
create
Custom
Resource
Definition
create
Deployment
create
Namespace
create
Role
create
Role
Binding
create
Service
create
Service
Account
create
Service
Account
Token
delete
Cluster
Custom
Object
delete
Deployment
delete
Namespace
delete
Service
get
All
Cluster
Custom
Objects
From
Resource
Definition
get
All
Custom
Resource
Definitions
get
All
Namespaces
get
Deployments
From
Namespace
get
Role
Bindings
get
Roles
get
Secrets
From
Namespace
get
Service
Accounts
From
Namespace
get
Services
From
Namespace
is
Namespace
Persisted
patch
Cluster
Custom
Object
Methods
create
Cluster
Custom
Object
createClusterCustomObject
<
CustomResource
extends
K8SCustomResource
>
(
dto
:
PersistClusterCustomObjectDTO
<
CustomResource
>
,
)
:
Promise
<
void
>
Type Parameters
CustomResource
extends
K8SCustomResource
Parameters
dto
:
PersistClusterCustomObjectDTO
<
CustomResource
>
Returns
Promise
<
void
>
create
Custom
Resource
Definition
createCustomResourceDefinition
(
dto
:
V1CustomResourceDefinition
)
:
Promise
<
void
>
Parameters
dto
:
V1CustomResourceDefinition
Returns
Promise
<
void
>
create
Deployment
createDeployment
(
dto
:
CreateDeploymentDTO
)
:
Promise
<
void
>
Parameters
dto
:
CreateDeploymentDTO
Returns
Promise
<
void
>
create
Namespace
createNamespace
(
name
:
string
)
:
Promise
<
void
>
Parameters
name
:
string
Returns
Promise
<
void
>
create
Role
createRole
(
dto
:
CreateRoleDTO
)
:
Promise
<
void
>
Parameters
dto
:
CreateRoleDTO
Returns
Promise
<
void
>
create
Role
Binding
createRoleBinding
(
dto
:
CreateRoleBindingDTO
)
:
Promise
<
void
>
Parameters
dto
:
CreateRoleBindingDTO
Returns
Promise
<
void
>
create
Service
createService
(
dto
:
CreateServiceDTO
)
:
Promise
<
void
>
Parameters
dto
:
CreateServiceDTO
Returns
Promise
<
void
>
create
Service
Account
createServiceAccount
(
dto
:
CreateServiceAccountDTO
)
:
Promise
<
void
>
Parameters
dto
:
CreateServiceAccountDTO
Returns
Promise
<
void
>
create
Service
Account
Token
createServiceAccountToken
(
dto
:
CreateServiceAccountTokenDTO
)
:
Promise
<
void
>
Parameters
dto
:
CreateServiceAccountTokenDTO
Returns
Promise
<
void
>
delete
Cluster
Custom
Object
deleteClusterCustomObject
<
CustomResource
extends
K8SCustomResource
>
(
dto
:
DeleteClusterCustomObjectDTO
<
CustomResource
>
,
)
:
Promise
<
void
>
Type Parameters
CustomResource
extends
K8SCustomResource
Parameters
dto
:
DeleteClusterCustomObjectDTO
<
CustomResource
>
Returns
Promise
<
void
>
delete
Deployment
deleteDeployment
(
dto
:
DeleteComponentDTO
)
:
Promise
<
void
>
Parameters
dto
:
DeleteComponentDTO
Returns
Promise
<
void
>
delete
Namespace
deleteNamespace
(
namespace
:
string
)
:
Promise
<
void
>
Parameters
namespace
:
string
Returns
Promise
<
void
>
delete
Service
deleteService
(
dto
:
DeleteComponentDTO
)
:
Promise
<
void
>
Parameters
dto
:
DeleteComponentDTO
Returns
Promise
<
void
>
get
All
Cluster
Custom
Objects
From
Resource
Definition
getAllClusterCustomObjectsFromResourceDefinition
<
CustomResource
extends
K8SCustomResource
,
>
(
dto
:
V1CustomResourceDefinition
,
)
:
Promise
<
CustomResource
[]
>
Type Parameters
CustomResource
extends
K8SCustomResource
Parameters
dto
:
V1CustomResourceDefinition
Returns
Promise
<
CustomResource
[]
>
get
All
Custom
Resource
Definitions
getAllCustomResourceDefinitions
()
:
Promise
<
V1CustomResourceDefinition
[]
>
Returns
Promise
<
V1CustomResourceDefinition
[]
>
get
All
Namespaces
getAllNamespaces
()
:
Promise
<
V1Namespace
[]
>
Returns
Promise
<
V1Namespace
[]
>
get
Deployments
From
Namespace
getDeploymentsFromNamespace
(
namespace
:
string
)
:
Promise
<
V1Deployment
[]
>
Parameters
namespace
:
string
Returns
Promise
<
V1Deployment
[]
>
get
Role
Bindings
getRoleBindings
(
dto
:
GetRoleBindingsDTO
)
:
Promise
<
V1RoleBinding
[]
>
Parameters
dto
:
GetRoleBindingsDTO
Returns
Promise
<
V1RoleBinding
[]
>
get
Roles
getRoles
(
dto
:
GetRolesDTO
)
:
Promise
<
V1Role
[]
>
Parameters
dto
:
GetRolesDTO
Returns
Promise
<
V1Role
[]
>
get
Secrets
From
Namespace
getSecretsFromNamespace
(
namespace
:
string
)
:
Promise
<
V1Secret
[]
>
Parameters
namespace
:
string
Returns
Promise
<
V1Secret
[]
>
get
Service
Accounts
From
Namespace
getServiceAccountsFromNamespace
(
namespace
:
string
)
:
Promise
<
V1ServiceAccount
[]
>
Parameters
namespace
:
string
Returns
Promise
<
V1ServiceAccount
[]
>
get
Services
From
Namespace
getServicesFromNamespace
(
namespace
:
string
)
:
Promise
<
V1Service
[]
>
Parameters
namespace
:
string
Returns
Promise
<
V1Service
[]
>
is
Namespace
Persisted
isNamespacePersisted
(
name
:
string
)
:
Promise
<
boolean
>
Parameters
name
:
string
Returns
Promise
<
boolean
>
patch
Cluster
Custom
Object
patchClusterCustomObject
<
CustomResource
extends
K8SCustomResource
>
(
dto
:
PersistClusterCustomObjectDTO
<
CustomResource
>
,
)
:
Promise
<
void
>
Type Parameters
CustomResource
extends
K8SCustomResource
Parameters
dto
:
PersistClusterCustomObjectDTO
<
CustomResource
>
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
create
Cluster
Custom
Object
create
Custom
Resource
Definition
create
Deployment
create
Namespace
create
Role
create
Role
Binding
create
Service
create
Service
Account
create
Service
Account
Token
delete
Cluster
Custom
Object
delete
Deployment
delete
Namespace
delete
Service
get
All
Cluster
Custom
Objects
From
Resource
Definition
get
All
Custom
Resource
Definitions
get
All
Namespaces
get
Deployments
From
Namespace
get
Role
Bindings
get
Roles
get
Secrets
From
Namespace
get
Service
Accounts
From
Namespace
get
Services
From
Namespace
is
Namespace
Persisted
patch
Cluster
Custom
Object
Examples
GitHub
Contribute
Stacks
Loading...