Skip to content

@k8slens/extensions

Globals / "src/renderer/api/endpoints/deployment.api" / Deployment

Class: Deployment#

Hierarchy#

Deployment

Implements#

Index#

Constructors#

Properties#

Accessors#

Methods#

Constructors#

constructor#

+ new Deployment(data: KubeJsonApiData): Deployment

Inherited from KubeObject.constructor

Defined in src/renderer/api/kube-object.ts:69

Parameters:

Name Type
data KubeJsonApiData

Returns: Deployment

Properties#

apiVersion#

apiVersion: string

Inherited from KubeObject.apiVersion

Defined in src/renderer/api/kube-object.ts:75


kind#

kind: string

Inherited from KubeObject.kind

Defined in src/renderer/api/kube-object.ts:76


metadata#

metadata: IKubeObjectMetadata

Inherited from KubeObject.metadata

Defined in src/renderer/api/kube-object.ts:77


spec#

spec: { replicas: number ; selector: { matchLabels: { [app:string]: string; } } ; strategy: { rollingUpdate: { maxSurge: number ; maxUnavailable: number } ; type: string } ; template: { metadata: { annotations?: { [app:string]: string; } ; creationTimestamp?: string ; labels: { [app:string]: string; } } ; spec: { affinity?: IAffinity ; containers: { args?: string[] ; env?: { name: string ; value: string }[] ; image: string ; imagePullPolicy: string ; livenessProbe?: { failureThreshold: number ; httpGet: { path: string ; port: number ; scheme: string } ; initialDelaySeconds: number ; periodSeconds: number ; successThreshold: number ; timeoutSeconds: number } ; name: string ; ports?: { containerPort: number ; name: string ; protocol: string }[] ; readinessProbe?: { failureThreshold: number ; httpGet: { path: string ; port: number ; scheme: string } ; initialDelaySeconds: number ; periodSeconds: number ; successThreshold: number ; timeoutSeconds: number } ; resources: { limits?: { cpu: string ; memory: string } ; requests: { cpu: string ; memory: string } } ; terminationMessagePath: string ; terminationMessagePolicy: string ; volumeMounts?: { mountPath: string ; name: string }[] }[] ; dnsPolicy: string ; nodeSelector?: { [selector:string]: string; } ; restartPolicy: string ; schedulerName: string ; securityContext: {} ; serviceAccount: string ; serviceAccountName: string ; terminationGracePeriodSeconds: number ; tolerations?: { effect: string ; key: string ; operator: string ; tolerationSeconds: number }[] ; volumes?: { configMap: { defaultMode: number ; name: string ; optional: boolean } ; name: string }[] } } }

Overrides WorkloadKubeObject.spec

Defined in src/renderer/api/endpoints/deployment.api.ts:55

Type declaration:

Name Type
replicas number
selector { matchLabels: { [app:string]: string; } }
strategy { rollingUpdate: { maxSurge: number ; maxUnavailable: number } ; type: string }
template { metadata: { annotations?: { [app:string]: string; } ; creationTimestamp?: string ; labels: { [app:string]: string; } } ; spec: { affinity?: IAffinity ; containers: { args?: string[] ; env?: { name: string ; value: string }[] ; image: string ; imagePullPolicy: string ; livenessProbe?: { failureThreshold: number ; httpGet: { path: string ; port: number ; scheme: string } ; initialDelaySeconds: number ; periodSeconds: number ; successThreshold: number ; timeoutSeconds: number } ; name: string ; ports?: { containerPort: number ; name: string ; protocol: string }[] ; readinessProbe?: { failureThreshold: number ; httpGet: { path: string ; port: number ; scheme: string } ; initialDelaySeconds: number ; periodSeconds: number ; successThreshold: number ; timeoutSeconds: number } ; resources: { limits?: { cpu: string ; memory: string } ; requests: { cpu: string ; memory: string } } ; terminationMessagePath: string ; terminationMessagePolicy: string ; volumeMounts?: { mountPath: string ; name: string }[] }[] ; dnsPolicy: string ; nodeSelector?: { [selector:string]: string; } ; restartPolicy: string ; schedulerName: string ; securityContext: {} ; serviceAccount: string ; serviceAccountName: string ; terminationGracePeriodSeconds: number ; tolerations?: { effect: string ; key: string ; operator: string ; tolerationSeconds: number }[] ; volumes?: { configMap: { defaultMode: number ; name: string ; optional: boolean } ; name: string }[] } }

status#

status: { availableReplicas?: number ; conditions: { lastTransitionTime: string ; lastUpdateTime: string ; message: string ; reason: string ; status: string ; type: string }[] ; observedGeneration: number ; readyReplicas: number ; replicas: number ; unavailableReplicas?: number ; updatedReplicas: number }

Overrides KubeObject.status

Defined in src/renderer/api/endpoints/deployment.api.ts:155

Type declaration:

Name Type
availableReplicas? number
conditions { lastTransitionTime: string ; lastUpdateTime: string ; message: string ; reason: string ; status: string ; type: string }[]
observedGeneration number
readyReplicas number
replicas number
unavailableReplicas? number
updatedReplicas number

apiBase#

Static apiBase: string = "/apis/apps/v1/deployments"

Defined in src/renderer/api/endpoints/deployment.api.ts:53


kind#

Static kind: string = "Deployment"

Overrides KubeObject.kind

Defined in src/renderer/api/endpoints/deployment.api.ts:51


namespaced#

Static namespaced: boolean = true

Overrides KubeObject.namespaced

Defined in src/renderer/api/endpoints/deployment.api.ts:52

Accessors#

• get selfLink(): string

Inherited from KubeObject.selfLink

Defined in src/renderer/api/kube-object.ts:80

Returns: string

Methods#

delete#

delete(params?: JsonApiParams): CancelablePromise\<KubeJsonApiData>

Inherited from KubeObject.delete

Defined in src/renderer/api/kube-object.ts:160

Parameters:

Name Type
params? JsonApiParams

Returns: CancelablePromise\<KubeJsonApiData>


getAffinity#

getAffinity(): IAffinity

Inherited from WorkloadKubeObject.getAffinity

Defined in src/renderer/api/workload-kube-object.ts:71

Returns: IAffinity


getAffinityNumber#

getAffinityNumber(): number

Inherited from WorkloadKubeObject.getAffinityNumber

Defined in src/renderer/api/workload-kube-object.ts:75

Returns: number


getAge#

getAge(humanize?: boolean, compact?: boolean, fromNow?: boolean): string | number

Inherited from KubeObject.getAge

Defined in src/renderer/api/kube-object.ts:102

Parameters:

Name Type Default value
humanize boolean true
compact boolean true
fromNow boolean false

Returns: string | number


getAnnotations#

getAnnotations(filter?: boolean): string[]

Inherited from KubeObject.getAnnotations

Defined in src/renderer/api/kube-object.ts:121

Parameters:

Name Type Default value
filter boolean false

Returns: string[]


getConditions#

getConditions(activeOnly?: boolean): { lastTransitionTime: string ; lastUpdateTime: string ; message: string ; reason: string ; status: string ; type: string }[]

Defined in src/renderer/api/endpoints/deployment.api.ts:172

Parameters:

Name Type Default value
activeOnly boolean false

Returns: { lastTransitionTime: string ; lastUpdateTime: string ; message: string ; reason: string ; status: string ; type: string }[]


getConditionsText#

getConditionsText(activeOnly?: boolean): string

Defined in src/renderer/api/endpoints/deployment.api.ts:181

Parameters:

Name Type Default value
activeOnly boolean true

Returns: string


getFinalizers#

getFinalizers(): string[]

Inherited from KubeObject.getFinalizers

Defined in src/renderer/api/kube-object.ts:113

Returns: string[]


getId#

getId(): string

Implementation of ItemObject

Inherited from KubeObject.getId

Defined in src/renderer/api/kube-object.ts:84

Returns: string


getLabels#

getLabels(): string[]

Inherited from KubeObject.getLabels

Defined in src/renderer/api/kube-object.ts:117

Returns: string[]


getName#

getName(): string

Implementation of ItemObject

Inherited from KubeObject.getName

Defined in src/renderer/api/kube-object.ts:92

Returns: string


getNodeSelectors#

getNodeSelectors(): string[]

Inherited from WorkloadKubeObject.getNodeSelectors

Defined in src/renderer/api/workload-kube-object.ts:57

Returns: string[]


getNs#

getNs(): string

Inherited from KubeObject.getNs

Defined in src/renderer/api/kube-object.ts:96

Returns: string


getOwnerRefs#

getOwnerRefs(): { namespace: string = this.getNs() }[]

Inherited from KubeObject.getOwnerRefs

Defined in src/renderer/api/kube-object.ts:129

Returns: { namespace: string = this.getNs() }[]


getReplicas#

getReplicas(): number

Defined in src/renderer/api/endpoints/deployment.api.ts:185

Returns: number


getResourceVersion#

getResourceVersion(): string

Inherited from KubeObject.getResourceVersion

Defined in src/renderer/api/kube-object.ts:88

Returns: string


getSearchFields#

getSearchFields(): string[]

Inherited from KubeObject.getSearchFields

Defined in src/renderer/api/kube-object.ts:137

Returns: string[]


getSelectors#

getSelectors(): string[]

Inherited from WorkloadKubeObject.getSelectors

Defined in src/renderer/api/workload-kube-object.ts:52

Returns: string[]


getTemplateLabels#

getTemplateLabels(): string[]

Inherited from WorkloadKubeObject.getTemplateLabels

Defined in src/renderer/api/workload-kube-object.ts:62

Returns: string[]


getTolerations#

getTolerations(): IToleration[]

Inherited from WorkloadKubeObject.getTolerations

Defined in src/renderer/api/workload-kube-object.ts:67

Returns: IToleration[]


toPlainObject#

toPlainObject(): object

Inherited from KubeObject.toPlainObject

Defined in src/renderer/api/kube-object.ts:148

Returns: object


update#

update\(data: Partial\): Promise\

Inherited from KubeObject.update

Defined in src/renderer/api/kube-object.ts:153

Type parameters:

Name Type
T KubeObject

Parameters:

Name Type
data Partial\

Returns: Promise\


create#

Staticcreate(data: any): KubeObject

Inherited from KubeObject.create

Defined in src/renderer/api/kube-object.ts:50

Parameters:

Name Type
data any

Returns: KubeObject


isJsonApiData#

StaticisJsonApiData(object: any): object is KubeJsonApiData

Inherited from KubeObject.isJsonApiData

Defined in src/renderer/api/kube-object.ts:58

Parameters:

Name Type
object any

Returns: object is KubeJsonApiData


isJsonApiDataList#

StaticisJsonApiDataList(object: any): object is KubeJsonApiDataList

Inherited from KubeObject.isJsonApiDataList

Defined in src/renderer/api/kube-object.ts:62

Parameters:

Name Type
object any

Returns: object is KubeJsonApiDataList


isNonSystem#

StaticisNonSystem(item: KubeJsonApiData | KubeObject): boolean

Inherited from KubeObject.isNonSystem

Defined in src/renderer/api/kube-object.ts:54

Parameters:

Name Type
item KubeJsonApiData | KubeObject

Returns: boolean


stringifyLabels#

StaticstringifyLabels(labels: { [name:string]: string; }): string[]

Inherited from KubeObject.stringifyLabels

Defined in src/renderer/api/kube-object.ts:66

Parameters:

Name Type
labels { [name:string]: string; }

Returns: string[]


Last update: November 10, 2020