From bd17a10704b7f84a8801b0297c997472476c56a4 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 5 Jul 2018 00:27:51 +0200 Subject: [PATCH 01/40] First implementation of KubeHelp object with the move out of text generation --- lib/commands/describe.py | 2 +- lib/kube_help.py | 69 ++++++++++++++++++++++++++++++++++++ lib/kube_obj.py | 76 ++++++++++++++-------------------------- 3 files changed, 97 insertions(+), 50 deletions(-) create mode 100644 lib/kube_help.py diff --git a/lib/commands/describe.py b/lib/commands/describe.py index fa0e72b..a355aa1 100644 --- a/lib/commands/describe.py +++ b/lib/commands/describe.py @@ -85,7 +85,7 @@ def run(self, args): print('', file=sys.stdout) found = True print('.'.join(ss[0:]) + ':', file=sys.stdout) - print(obj.get_help(), file=sys.stdout) + print(obj.get_help().render_terminal(), file=sys.stdout) if not found: return 1 diff --git a/lib/kube_help.py b/lib/kube_help.py new file mode 100644 index 0000000..99ee0fd --- /dev/null +++ b/lib/kube_help.py @@ -0,0 +1,69 @@ +# (c) Copyright 2018-2019 OLX + +from __future__ import absolute_import +from __future__ import division +from __future__ import print_function +from __future__ import unicode_literals + +from kube_types import Map, String + + +# Object used to collect class definition and implement the rendering functions +class KubeHelper(object): + _class_name = None + _class_subclasses = None + _class_superclasses = None + _class_types = {} + _class_is_abstract = None + _class_identifier = None + _class_mapping = [] + _class_parent_types = None + _class_has_metadata = None + _class_doc = None + _class_doc_link = None + _class_xf_hasattr = [] + + def __init__(self, *args, **kwargs): + if 'name' in kwargs: + self._class_name = kwargs['name'] + if 'document' in kwargs: + self._class_doc = kwargs['document'] + if 'documentlink' in kwargs: + self._class_doc_link = kwargs['documentlink'] + + def render_terminal(self): + txt = '{}{}:\n'.format(self._class_name, self._class_is_abstract) + + if len(self._class_superclasses) != 0: + txt += ' parents: {}\n'.format(', '.join(self._class_superclasses)) + if len(self._class_subclasses) != 0: + txt += ' children: {}\n'.format(', '.join(self._class_subclasses)) + if len(self._class_parent_types) != 0: + txt += ' parent types: {}\n'.format(', '.join(sorted(self._class_parent_types.keys()))) + if self._class_has_metadata: + txt += ' metadata:\n' + txt += ' annotations: {}\n'.format(Map(String, String).name()) + txt += ' labels: {}\n'.format(Map(String, String).name()) + txt += ' properties:\n' + if self._class_identifier is not None: + spc = '' + if len(self._class_identifier) < 7: + spc = (7 - len(self._class_identifier)) * ' ' + txt += ' {} (identifier): {}{}\n'.format(self._class_identifier, spc, self._class_types[self._class_identifier].name()) + + for p in sorted(self._class_types.keys()): + if p == self._class_identifier: + continue + spc = '' + if len(p) < 20: + spc = (20 - len(p)) * ' ' + xf = '*' if 'xf_{}'.format(p) in self._class_xf_hasattr else ' ' + + txt += ' {}{}: {}{}\n'.format(xf, p, spc, self._class_types[p].name()) + if p in self._class_mapping: + txt += ' ({})\n'.format(', '.join(self._class_mapping[p])) + + return txt + + def render_markdown(self): + pass \ No newline at end of file diff --git a/lib/kube_obj.py b/lib/kube_obj.py index 343c690..4d739a3 100644 --- a/lib/kube_obj.py +++ b/lib/kube_obj.py @@ -9,8 +9,10 @@ import traceback import sys from collections import OrderedDict +from kube_help import KubeHelper -from kube_types import * +from kube_types import Integer, Positive, NonZero, Number, Boolean +from kube_types import String, Map, List, Identifier, NonEmpty, KubeType from user_error import UserError, paths as user_error_paths @@ -49,7 +51,7 @@ def __init__(self, text, obj, input_doc): self.doc = input_doc def __repr__(self): - return '{}(obj={}, doc={})'.format(self.__class__.__name__, self.obj.__name__, repr(doc)) + return '{}(obj={}, doc={})'.format(self.__class__.__name__, self.obj.__name__, repr(self.doc)) class KubeTypeUnresolvable(Exception): @@ -74,6 +76,7 @@ class KubeBaseObj(object): has_metadata = False _is_openshift = False _always_regenerate = False + _document_url = None def __init__(self, *args, **kwargs): # put the identifier in if it's specified @@ -237,7 +240,7 @@ def basic_validation(typ): tk = basic_validation(kk) tv = basic_validation(vv) if tk is not None and tv is not None: - types[k] = NonEmpty(Dict(tk, tv)) + types[k] = NonEmpty(dict(tk, tv)) if not isinstance(types[k], KubeType): raise KubeTypeUnresolvable( @@ -304,6 +307,12 @@ def _rec_subclasses(kls): @classmethod def get_help(cls): + ret_help = KubeHelper( + name=cls.__name__, + document=cls.__class__.__doc__, + documentlink=cls._document_url + ) + def _rec_superclasses(kls): ret = [] superclasses = list(filter(lambda x: x is not KubeBaseObj and x is not KubeSubObj and @@ -317,58 +326,27 @@ def _rec_superclasses(kls): return ret - subclasses = list(map(lambda x: x.__name__, cls.get_subclasses(non_abstract=False, include_self=False))) - superclasses = list(map(lambda x: x.__name__, _rec_superclasses(cls))) + ret_help._class_subclasses = list(map(lambda x: x.__name__, cls.get_subclasses(non_abstract=False, include_self=False))) + ret_help._class_superclasses = list(map(lambda x: x.__name__, _rec_superclasses(cls))) - types = cls.resolve_types() + ret_help._class_types = cls.resolve_types() - abstract = '' - if cls.is_abstract_type(): - abstract = ' (abstract type)' - - identifier = None - if hasattr(cls, 'identifier') and cls.identifier is not None: - identifier = cls.identifier - - txt = '{}{}:\n'.format(cls.__name__, abstract) - if len(superclasses) != 0: - txt += ' parents: {}\n'.format(', '.join(superclasses)) - if len(subclasses) != 0: - txt += ' children: {}\n'.format(', '.join(subclasses)) - if len(cls._parent_types) != 0: - txt += ' parent types: {}\n'.format(', '.join(sorted(cls._parent_types.keys()))) - if cls.has_metadata: - txt += ' metadata:\n' - txt += ' annotations: {}\n'.format(Map(String, String).name()) - txt += ' labels: {}\n'.format(Map(String, String).name()) - txt += ' properties:\n' - if identifier is not None: - spc = '' - if len(identifier) < 7: - spc = (7 - len(identifier)) * ' ' - txt += ' {} (identifier): {}{}\n'.format(identifier, spc, types[identifier].name()) + ret_help._class_is_abstract = '' if cls.is_abstract_type() else ' (abstract type)' + ret_help._class_identifier = cls.identifier if hasattr(cls, 'identifier') and cls.identifier is not None else None mapping = cls._find_defaults('_map') - rmapping = {} + ret_help._class_mapping = {} for d in mapping: - if mapping[d] not in rmapping: - rmapping[mapping[d]] = [] - rmapping[mapping[d]].append(d) + if mapping[d] not in ret_help._class_mapping: + ret_help._class_mapping[mapping[d]] = [] + ret_help._class_mapping[mapping[d]].append(d) - for p in sorted(types.keys()): - if p == identifier: - continue - spc = '' - if len(p) < 20: - spc = (20 - len(p)) * ' ' - if hasattr(cls, 'xf_{}'.format(p)): - xf = '*' - else: - xf = ' ' - txt += ' {}{}: {}{}\n'.format(xf, p, spc, types[p].name()) - if p in rmapping: - txt += ' ({})\n'.format(', '.join(rmapping[p])) - return txt + ret_help._class_parent_types = cls._parent_types + ret_help._class_has_metadata = cls.has_metadata + + ret_help._class_xf_hasattr = ['xf_{}'.format(p) for p in sorted(ret_help._class_types.keys()) if hasattr(cls, 'xf_{}'.format(p))] + + return ret_help def has_child_object(self, obj): assert isinstance(obj, KubeBaseObj) From 96f9f8ac58c5625a17719138e44f49a3c70d3077 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 5 Jul 2018 00:54:29 +0200 Subject: [PATCH 02/40] Added first rudimental render_markdown function inside KubeHelp class --- lib/kube_help.py | 14 ++++++++++++-- lib/kube_obj.py | 2 +- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/lib/kube_help.py b/lib/kube_help.py index 99ee0fd..7f0b6db 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -33,7 +33,7 @@ def __init__(self, *args, **kwargs): def render_terminal(self): txt = '{}{}:\n'.format(self._class_name, self._class_is_abstract) - + if len(self._class_superclasses) != 0: txt += ' parents: {}\n'.format(', '.join(self._class_superclasses)) if len(self._class_subclasses) != 0: @@ -66,4 +66,14 @@ def render_terminal(self): return txt def render_markdown(self): - pass \ No newline at end of file + description = '```\n{}\n```'.format(self.render_terminal()) + + title = '## {}\n'.format(self._class_name) + if self._class_doc_link is not None: + title = '## [{}]({})\n'.format(self._class_name, self._class_doc_link) + + if self._class_doc is not None: + return '{}\n{}\n\n{}\n'.format(title, self._class_doc, description) + else: + return '{}\n{}\n'.format(title, description) + \ No newline at end of file diff --git a/lib/kube_obj.py b/lib/kube_obj.py index 4d739a3..e2df21a 100644 --- a/lib/kube_obj.py +++ b/lib/kube_obj.py @@ -309,7 +309,7 @@ def _rec_subclasses(kls): def get_help(cls): ret_help = KubeHelper( name=cls.__name__, - document=cls.__class__.__doc__, + document=cls.__doc__, documentlink=cls._document_url ) From 988916b9073d78b4f26e721ad59ab55e70cb13dd Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 5 Jul 2018 07:38:19 +0200 Subject: [PATCH 03/40] Basic implementation of docgen command --- docs/rubiks.class.md | 1187 ++++++++++++++++++++++++++++++++++++++++ lib/commands/docgen.py | 28 + 2 files changed, 1215 insertions(+) create mode 100644 docs/rubiks.class.md create mode 100644 lib/commands/docgen.py diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md new file mode 100644 index 0000000..dd271f5 --- /dev/null +++ b/docs/rubiks.class.md @@ -0,0 +1,1187 @@ +## TLSCredentials + +``` +TLSCredentials (abstract type): + parents: Secret + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + secrets: Map + tls_cert: String + tls_key: String + type: NonEmpty + +``` +## Service + +``` +Service: + children: ClusterIPService, AWSLoadBalancerService + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + *ports: NonEmpty> + *selector: NonEmpty> + sessionAffinity: Nullable + +``` +## DockerCredentials + +``` +DockerCredentials (abstract type): + parents: Secret + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + dockers: Map> + secrets: Map + type: NonEmpty + +``` +## DplBaseUpdateStrategy + +``` +DplBaseUpdateStrategy: + children: DplRecreateStrategy, DplRollingUpdateStrategy + parent types: Deployment + properties: + +``` +## Role + +``` +Role (abstract type): + parents: RoleBase + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + rules: NonEmpty> + +``` +## Group + +``` +Group (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + users: NonEmpty> + +``` +## RouteTLS + +``` +RouteTLS (abstract type): + parent types: Route + properties: + caCertificate: Nullable> + certificate: Nullable> + destinationCACertificate: Nullable> + insecureEdgeTerminationPolicy: Enum(u'Allow', u'Disable', u'Redirect') + key: Nullable> + termination: Enum(u'edge', u'reencrypt', u'passthrough') + +``` +## SCCRunAsUser + +``` +SCCRunAsUser (abstract type): + parent types: SecurityContextConstraints + properties: + type: Enum(u'MustRunAs', u'RunAsAny', u'MustRunAsRange', u'MustRunAsNonRoot') + uid: Nullable>> + uidRangeMax: Nullable>> + uidRangeMin: Nullable>> + +``` +## PersistentVolumeClaim + +``` +PersistentVolumeClaim (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + accessModes: List + request: Memory + selector: Nullable + *volumeName: Nullable + +``` +## PodVolumePVCSpec + +``` +PodVolumePVCSpec (abstract type): + parents: PodVolumeBaseSpec + parent types: PodTemplateSpec + properties: + claimName: Identifier + name: Identifier + +``` +## DCConfigChangeTrigger + +``` +DCConfigChangeTrigger (abstract type): + parents: DCTrigger + parent types: DeploymentConfig + properties: + +``` +## SecurityContext + +``` +SecurityContext (abstract type): + parent types: ContainerSpec, PodTemplateSpec + properties: + fsGroup: Nullable + privileged: Nullable + runAsNonRoot: Nullable + runAsUser: Nullable + supplementalGroups: Nullable> + +``` +## Project + +``` +Project (abstract type): + parents: Namespace + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + +``` +## PersistentVolume + +``` +PersistentVolume (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + accessModes: List + awsElasticBlockStore: Nullable + capacity: Memory + claimRef: Nullable + persistentVolumeReclaimPolicy: Nullable + +``` +## DeploymentConfig + +``` +DeploymentConfig (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + minReadySeconds: Nullable>> + paused: Nullable + pod_template: PodTemplateSpec + replicas: Positive> + revisionHistoryLimit: Nullable>> + selector: Nullable> + strategy: DCBaseUpdateStrategy + test: Boolean + triggers: List + +``` +## ContainerPort + +``` +ContainerPort (abstract type): + parent types: ContainerSpec + properties: + containerPort: Positive> + hostIP: Nullable + hostPort: Nullable>> + name: Nullable + protocol: Enum(u'TCP', u'UDP') + +``` +## DCImageChangeTrigger + +``` +DCImageChangeTrigger (abstract type): + parents: DCTrigger + parent types: DeploymentConfig + properties: + +``` +## RoleRef + +``` +RoleRef (abstract type): + parent types: ClusterRoleBinding, PolicyBindingRoleBinding, RoleBinding, RoleBindingBase + properties: + name: Nullable + ns: Nullable + +``` +## LifeCycleHTTP + +``` +LifeCycleHTTP (abstract type): + parents: LifeCycleProbe + parent types: LifeCycle + properties: + path: NonEmpty + port: Positive> + scheme: Nullable + +``` +## PodVolumeItemMapper + +``` +PodVolumeItemMapper: + parents: PodVolumeBaseSpec + children: PodVolumeConfigMapSpec, PodVolumeSecretSpec + parent types: PodTemplateSpec + properties: + item_map: Nullable> + name: Identifier + +``` +## DaemonSet + +``` +DaemonSet (abstract type): + parents: SelectorsPreProcessMixin + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + pod_template: PodTemplateSpec + *selector: Nullable + +``` +## DCBaseUpdateStrategy + +``` +DCBaseUpdateStrategy: + children: DCRecreateStrategy, DCRollingStrategy, DCCustomStrategy + parent types: DeploymentConfig + properties: + activeDeadlineSeconds: Nullable>> + annotations: Map + labels: Map + resources: Nullable + +``` +## Namespace + +``` +Namespace (abstract type): + children: Project + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + +``` +## ContainerEnvSpec + +``` +ContainerEnvSpec (abstract type): + parents: ContainerEnvBaseSpec + parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod + properties: + name: EnvString + value: String + +``` +## PodVolumeConfigMapSpec + +``` +PodVolumeConfigMapSpec (abstract type): + parents: PodVolumeItemMapper, PodVolumeBaseSpec + parent types: PodTemplateSpec + properties: + defaultMode: Nullable> + item_map: Nullable> + map_name: Identifier + name: Identifier + +``` +## MatchExpression + +``` +MatchExpression (abstract type): + parent types: MatchExpressionsSelector + properties: + key: NonEmpty + operator: Enum(u'In', u'NotIn', u'Exists', u'DoesNotExist') + values: Nullable> + +``` +## SCCSELinux + +``` +SCCSELinux (abstract type): + parent types: SecurityContextConstraints + properties: + level: Nullable + role: Nullable + strategy: Nullable + type: Nullable + user: Nullable + +``` +## ClusterRoleBinding + +``` +ClusterRoleBinding (abstract type): + parents: RoleBindingBase, RoleBindingXF + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + *roleRef: RoleRef + *subjects: NonEmpty> + +``` +## AWSLoadBalancerService + +``` +AWSLoadBalancerService (abstract type): + parents: Service + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + aws-load-balancer-backend-protocol: Nullable + aws-load-balancer-ssl-cert: Nullable + externalTrafficPolicy: Nullable + *ports: NonEmpty> + *selector: NonEmpty> + sessionAffinity: Nullable + +``` +## Job + +``` +Job (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + activeDeadlineSeconds: Nullable> + completions: Nullable>> + manualSelector: Nullable + parallelism: Nullable>> + pod_template: PodTemplateSpec + selector: Nullable + +``` +## RouteDestService + +``` +RouteDestService (abstract type): + parents: RouteDest + parent types: Route + properties: + name: Identifier + weight: Positive> + +``` +## DCRecreateStrategy + +``` +DCRecreateStrategy (abstract type): + parents: DCBaseUpdateStrategy + parent types: DeploymentConfig + properties: + activeDeadlineSeconds: Nullable>> + annotations: Map + customParams: Nullable + labels: Map + recreateParams: Nullable + resources: Nullable + +``` +## DplRollingUpdateStrategy + +``` +DplRollingUpdateStrategy (abstract type): + parents: DplBaseUpdateStrategy + parent types: Deployment + properties: + maxSurge: SurgeSpec + maxUnavailable: SurgeSpec + +``` +## ContainerSpec + +``` +ContainerSpec (abstract type): + parents: EnvironmentPreProcessMixin + parent types: PodTemplateSpec + properties: + name (identifier): Identifier + args: Nullable> + command: Nullable> + *env: Nullable> + image: NonEmpty + imagePullPolicy: Nullable + kind: Nullable + lifecycle: Nullable + livenessProbe: Nullable + *ports: Nullable> + readinessProbe: Nullable + resources: Nullable + securityContext: Nullable + terminationMessagePath: Nullable> + *volumeMounts: Nullable> + +``` +## DplRecreateStrategy + +``` +DplRecreateStrategy (abstract type): + parents: DplBaseUpdateStrategy + parent types: Deployment + properties: + +``` +## DCTrigger + +``` +DCTrigger: + children: DCConfigChangeTrigger, DCImageChangeTrigger + parent types: DeploymentConfig + properties: + +``` +## ContainerEnvSecretSpec + +``` +ContainerEnvSecretSpec (abstract type): + parents: ContainerEnvBaseSpec + parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod + properties: + key: NonEmpty + name: EnvString + secret_name: Identifier + +``` +## MatchExpressionsSelector + +``` +MatchExpressionsSelector (abstract type): + parents: BaseSelector + parent types: DaemonSet, Deployment, Job, PersistentVolumeClaim + properties: + matchExpressions: NonEmpty> + +``` +## ContainerProbeBaseSpec + +``` +ContainerProbeBaseSpec: + children: ContainerProbeTCPPortSpec, ContainerProbeHTTPSpec + parent types: ContainerSpec + properties: + failureThreshold: Nullable>> + initialDelaySeconds: Nullable> + periodSeconds: Nullable>> + successThreshold: Nullable>> + timeoutSeconds: Nullable>> + +``` +## PodVolumeEmptyDirSpec + +``` +PodVolumeEmptyDirSpec (abstract type): + parents: PodVolumeBaseSpec + parent types: PodTemplateSpec + properties: + name: Identifier + +``` +## PolicyBinding + +``` +PolicyBinding (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): ColonIdentifier + *roleBindings: List + +``` +## ConfigMap + +``` +ConfigMap (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + files: Map + +``` +## SCCGroups + +``` +SCCGroups (abstract type): + parent types: SecurityContextConstraints + properties: + ranges: Nullable> + type: Nullable + +``` +## DCCustomStrategy + +``` +DCCustomStrategy (abstract type): + parents: DCBaseUpdateStrategy + parent types: DeploymentConfig + properties: + activeDeadlineSeconds: Nullable>> + annotations: Map + customParams: DCCustomParams + labels: Map + resources: Nullable + +``` +## ContainerResourceEachSpec + +``` +ContainerResourceEachSpec (abstract type): + parent types: ContainerResourceSpec + properties: + *cpu: Nullable>> + memory: Nullable + +``` +## StorageClass + +``` +StorageClass (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + parameters: Map + provisioner: String + +``` +## DCRollingParams + +``` +DCRollingParams (abstract type): + parent types: DCRollingStrategy + properties: + intervalSeconds: Nullable>> + maxSurge: SurgeSpec + maxUnavailable: SurgeSpec + post: Nullable + pre: Nullable + timeoutSeconds: Nullable>> + updatePeriodSeconds: Nullable>> + +``` +## SCCGroupRange + +``` +SCCGroupRange (abstract type): + parent types: SCCGroups + properties: + max: Positive> + min: Positive> + +``` +## DCCustomParams + +``` +DCCustomParams (abstract type): + parents: EnvironmentPreProcessMixin + parent types: DCCustomStrategy, DCRecreateStrategy, DCRollingStrategy + properties: + command: Nullable> + *environment: Nullable> + image: NonEmpty + +``` +## ContainerVolumeMountSpec + +``` +ContainerVolumeMountSpec (abstract type): + parent types: ContainerSpec, DCLifecycleNewPod + properties: + name: Identifier + path: NonEmpty + readOnly: Nullable + +``` +## LifeCycleProbe + +``` +LifeCycleProbe: + children: LifeCycleExec, LifeCycleHTTP + parent types: LifeCycle + properties: + +``` +## SASecretSubject + +``` +SASecretSubject (abstract type): + parent types: ServiceAccount + properties: + kind: Nullable + name: Nullable + ns: Nullable + +``` +## PodTemplateSpec + +``` +PodTemplateSpec (abstract type): + parent types: DaemonSet, Deployment, DeploymentConfig, Job, ReplicationController + metadata: + annotations: Map + labels: Map + properties: + containers: NonEmpty> + dnsPolicy: Nullable + hostIPC: Nullable + hostNetwork: Nullable + hostPID: Nullable + *imagePullSecrets: Nullable> + name: Nullable + nodeSelector: Nullable> + restartPolicy: Nullable + securityContext: Nullable + *serviceAccountName: Nullable + (serviceAccount) + terminationGracePeriodSeconds: Nullable> + volumes: Nullable> + +``` +## User + +``` +User (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): UserIdentifier + fullName: Nullable + identities: NonEmpty>> + +``` +## ContainerEnvConfigMapSpec + +``` +ContainerEnvConfigMapSpec (abstract type): + parents: ContainerEnvBaseSpec + parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod + properties: + key: NonEmpty + map_name: Identifier + name: EnvString + +``` +## LifeCycleExec + +``` +LifeCycleExec (abstract type): + parents: LifeCycleProbe + parent types: LifeCycle + properties: + command: NonEmpty> + +``` +## DCRollingStrategy + +``` +DCRollingStrategy (abstract type): + parents: DCBaseUpdateStrategy + parent types: DeploymentConfig + properties: + activeDeadlineSeconds: Nullable>> + annotations: Map + customParams: Nullable + labels: Map + resources: Nullable + rollingParams: Nullable + +``` +## RouteDest + +``` +RouteDest: + children: RouteDestService + parent types: Route + properties: + weight: Positive> + +``` +## ContainerEnvPodFieldSpec + +``` +ContainerEnvPodFieldSpec (abstract type): + parents: ContainerEnvBaseSpec + parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod + properties: + apiVersion: Nullable + fieldPath: Enum(u'metadata.name', u'metadata.namespace', u'metadata.labels', u'metadata.annotations', u'spec.nodeName', u'spec.serviceAccountName', u'status.podIP') + name: EnvString + +``` +## ServiceAccount + +``` +ServiceAccount (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + *imagePullSecrets: Nullable> + *secrets: Nullable> + +``` +## PodVolumeBaseSpec + +``` +PodVolumeBaseSpec: + children: PodVolumeHostSpec, PodVolumeItemMapper, PodVolumePVCSpec, PodVolumeEmptyDirSpec, PodVolumeConfigMapSpec, PodVolumeSecretSpec + parent types: PodTemplateSpec + properties: + name: Identifier + +``` +## ClusterRole + +``` +ClusterRole (abstract type): + parents: RoleBase + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + rules: NonEmpty> + +``` +## DCLifecycleHook + +``` +DCLifecycleHook (abstract type): + parent types: DCRecreateParams, DCRollingParams + properties: + execNewPod: Nullable + failurePolicy: Enum(u'Abort', u'Retry', u'Ignore') + tagImages: Nullable + +``` +## ClusterIPService + +``` +ClusterIPService (abstract type): + parents: Service + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + clusterIP: Nullable + *ports: NonEmpty> + *selector: NonEmpty> + sessionAffinity: Nullable + +``` +## PersistentVolumeRef + +``` +PersistentVolumeRef (abstract type): + parent types: PersistentVolume + properties: + apiVersion: Nullable + kind: Nullable + name: Nullable + ns: Nullable + +``` +## DCLifecycleNewPod + +``` +DCLifecycleNewPod (abstract type): + parents: EnvironmentPreProcessMixin + parent types: DCLifecycleHook + properties: + command: NonEmpty> + containerName: Identifier + *env: Nullable> + volumeMounts: Nullable> + volumes: Nullable> + +``` +## ContainerProbeTCPPortSpec + +``` +ContainerProbeTCPPortSpec (abstract type): + parents: ContainerProbeBaseSpec + parent types: ContainerSpec + properties: + failureThreshold: Nullable>> + initialDelaySeconds: Nullable> + periodSeconds: Nullable>> + *port: Positive> + successThreshold: Nullable>> + timeoutSeconds: Nullable>> + +``` +## ContainerEnvBaseSpec + +``` +ContainerEnvBaseSpec: + children: ContainerEnvSpec, ContainerEnvConfigMapSpec, ContainerEnvSecretSpec, ContainerEnvPodFieldSpec, ContainerEnvContainerResourceSpec + parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod + properties: + name: EnvString + +``` +## PodVolumeHostSpec + +``` +PodVolumeHostSpec (abstract type): + parents: PodVolumeBaseSpec + parent types: PodTemplateSpec + properties: + name: Identifier + path: String + +``` +## DCRecreateParams + +``` +DCRecreateParams (abstract type): + parent types: DCRecreateStrategy + properties: + mid: Nullable + post: Nullable + pre: Nullable + timeoutSeconds: Nullable>> + +``` +## DCTagImages + +``` +DCTagImages (abstract type): + parent types: DCLifecycleHook + properties: + containerName: Identifier + toApiVersion: Nullable + toFieldPath: Nullable + toKind: Nullable + toName: Nullable + toNamespace: Nullable + toResourceVersion: Nullable + toUid: Nullable + +``` +## Secret + +``` +Secret (abstract type): + children: DockerCredentials, TLSCredentials + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + secrets: Map + type: NonEmpty + +``` +## RouteDestPort + +``` +RouteDestPort (abstract type): + parent types: Route + properties: + targetPort: Identifier + +``` +## BaseSelector + +``` +BaseSelector: + children: MatchLabelsSelector, MatchExpressionsSelector + parent types: DaemonSet, Deployment, Job, PersistentVolumeClaim + properties: + +``` +## ContainerProbeHTTPSpec + +``` +ContainerProbeHTTPSpec (abstract type): + parents: ContainerProbeBaseSpec + parent types: ContainerSpec + properties: + failureThreshold: Nullable>> + host: Nullable + initialDelaySeconds: Nullable> + path: NonEmpty + periodSeconds: Nullable>> + *port: Positive> + scheme: Nullable + successThreshold: Nullable>> + timeoutSeconds: Nullable>> + +``` +## ServicePort + +``` +ServicePort (abstract type): + parent types: AWSLoadBalancerService, ClusterIPService, Service + properties: + name: Nullable + port: Positive> + protocol: Enum(u'TCP', u'UDP') + targetPort: OneOf>, Identifier> + +``` +## AWSElasticBlockStore + +``` +AWSElasticBlockStore (abstract type): + parent types: PersistentVolume + properties: + fsType: Enum(u'ext4') + volumeID: AWSVolID + +``` +## ReplicationController + +``` +ReplicationController (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + minReadySeconds: Nullable>> + pod_template: PodTemplateSpec + replicas: Positive> + selector: Nullable> + +``` +## SAImgPullSecretSubject + +``` +SAImgPullSecretSubject (abstract type): + parent types: ServiceAccount + properties: + name: Identifier + +``` +## Deployment + +``` +Deployment (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + minReadySeconds: Nullable>> + paused: Nullable + pod_template: PodTemplateSpec + progressDeadlineSeconds: Nullable>> + replicas: Positive> + revisionHistoryLimit: Nullable>> + selector: Nullable + strategy: Nullable + +``` +## PodImagePullSecret + +``` +PodImagePullSecret (abstract type): + parent types: PodTemplateSpec + properties: + name: Identifier + +``` +## RoleSubject + +``` +RoleSubject (abstract type): + parent types: ClusterRoleBinding, PolicyBindingRoleBinding, RoleBinding, RoleBindingBase + properties: + kind: CaseIdentifier + name: String + ns: Nullable + +``` +## SecurityContextConstraints + +``` +SecurityContextConstraints (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + allowHostDirVolumePlugin: Boolean + allowHostIPC: Boolean + allowHostNetwork: Boolean + allowHostPID: Boolean + allowHostPorts: Boolean + allowPrivilegedContainer: Boolean + allowedCapabilities: Nullable> + defaultAddCapabilities: Nullable> + fsGroup: Nullable + groups: List + priority: Nullable> + readOnlyRootFilesystem: Boolean + requiredDropCapabilities: Nullable> + runAsUser: Nullable + seLinuxContext: Nullable + seccompProfiles: Nullable> + supplementalGroups: Nullable + users: List + volumes: List + +``` +## Route + +``` +Route (abstract type): + metadata: + annotations: Map + labels: Map + properties: + name (identifier): Identifier + host: Domain + port: RouteDestPort + tls: Nullable + to: NonEmpty> + wildcardPolicy: Enum(u'Subdomain', u'None') + +``` +## ContainerResourceSpec + +``` +ContainerResourceSpec (abstract type): + parent types: ContainerSpec, DCBaseUpdateStrategy, DCCustomStrategy, DCRecreateStrategy, DCRollingStrategy + properties: + limits: ContainerResourceEachSpec + requests: ContainerResourceEachSpec + +``` +## PolicyBindingRoleBinding + +``` +PolicyBindingRoleBinding (abstract type): + parents: RoleBindingXF + parent types: PolicyBinding + properties: + metadata: Nullable> + name: SystemIdentifier + ns: Identifier + *roleRef: RoleRef + *subjects: NonEmpty> + +``` +## LifeCycle + +``` +LifeCycle (abstract type): + parent types: ContainerSpec + properties: + postStart: Nullable + preStop: Nullable + +``` +## RoleBinding + +``` +RoleBinding (abstract type): + parents: RoleBindingBase, RoleBindingXF + metadata: + annotations: Map + labels: Map + properties: + name (identifier): SystemIdentifier + *roleRef: RoleRef + *subjects: NonEmpty> + +``` +## MatchLabelsSelector + +``` +MatchLabelsSelector (abstract type): + parents: BaseSelector + parent types: DaemonSet, Deployment, Job, PersistentVolumeClaim + properties: + matchLabels: Map + +``` +## PolicyRule + +``` +PolicyRule (abstract type): + parent types: ClusterRole, Role, RoleBase + properties: + apiGroups: NonEmpty> + attributeRestrictions: Nullable + nonResourceURLs: Nullable> + resourceNames: Nullable> + resources: NonEmpty>> + verbs: NonEmpty> + +``` +## ContainerEnvContainerResourceSpec + +``` +ContainerEnvContainerResourceSpec (abstract type): + parents: ContainerEnvBaseSpec + parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod + properties: + containerName: Nullable + divisor: Nullable> + name: EnvString + resource: Enum(u'limits.cpu', u'limits.memory', u'requests.cpu', u'requests.memory') + +``` +## PodVolumeSecretSpec + +``` +PodVolumeSecretSpec (abstract type): + parents: PodVolumeItemMapper, PodVolumeBaseSpec + parent types: PodTemplateSpec + properties: + defaultMode: Nullable> + item_map: Nullable> + name: Identifier + secret_name: Identifier + +``` diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py new file mode 100644 index 0000000..8526680 --- /dev/null +++ b/lib/commands/docgen.py @@ -0,0 +1,28 @@ +# (c) Copyright 2018-2019 OLX + +from __future__ import absolute_import +from __future__ import division +from __future__ import print_function +from __future__ import unicode_literals + +from command import Command +from .bases import CommandRepositoryBase +import load_python +import os + +class Command_docgen(Command, CommandRepositoryBase): + """Generate a markdown file with basic description for all object inside rubiks""" + + def populate_args(self, parser): + pass + + def run(self, args): + objs = load_python.PythonBaseFile.get_kube_objs() + r = self.get_repository() + md = '' + + for oname in objs.keys(): + md += objs[oname].get_help().render_markdown() + + with open(os.path.join(r.basepath, 'docs/rubiks.class.md'), 'w') as f: + f.write(md) \ No newline at end of file From fb40f3e08f81264c2eb530396a9b73eb37b3553f Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 5 Jul 2018 09:16:42 +0200 Subject: [PATCH 04/40] New markdown test on github --- docs/rubiks.class.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index dd271f5..f9fb1d4 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -18,7 +18,7 @@ TLSCredentials (abstract type): ``` Service: - children: ClusterIPService, AWSLoadBalancerService + children: [ClusterIPService](#clusteripservice), [AWSLoadBalancerService](#awsloadbalancerservice) metadata: annotations: Map labels: Map @@ -48,7 +48,7 @@ DockerCredentials (abstract type): ``` DplBaseUpdateStrategy: - children: DplRecreateStrategy, DplRollingUpdateStrategy + children: [DplRecreateStrategy](#dplrecreatestrategy), [DplRollingUpdateStrategy](#dplrollingupdatestrategy) parent types: Deployment properties: @@ -249,7 +249,7 @@ LifeCycleHTTP (abstract type): ``` PodVolumeItemMapper: parents: PodVolumeBaseSpec - children: PodVolumeConfigMapSpec, PodVolumeSecretSpec + children: [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) parent types: PodTemplateSpec properties: item_map: Nullable> @@ -274,7 +274,7 @@ DaemonSet (abstract type): ``` DCBaseUpdateStrategy: - children: DCRecreateStrategy, DCRollingStrategy, DCCustomStrategy + children: [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy), [DCCustomStrategy](#dccustomstrategy) parent types: DeploymentConfig properties: activeDeadlineSeconds: Nullable>> @@ -287,7 +287,7 @@ DCBaseUpdateStrategy: ``` Namespace (abstract type): - children: Project + children: [Project](#project) metadata: annotations: Map labels: Map @@ -466,7 +466,7 @@ DplRecreateStrategy (abstract type): ``` DCTrigger: - children: DCConfigChangeTrigger, DCImageChangeTrigger + children: [DCConfigChangeTrigger](#dcconfigchangetrigger), [DCImageChangeTrigger](#dcimagechangetrigger) parent types: DeploymentConfig properties: @@ -497,7 +497,7 @@ MatchExpressionsSelector (abstract type): ``` ContainerProbeBaseSpec: - children: ContainerProbeTCPPortSpec, ContainerProbeHTTPSpec + children: [ContainerProbeTCPPortSpec](#containerprobetcpportspec), [ContainerProbeHTTPSpec](#containerprobehttpspec) parent types: ContainerSpec properties: failureThreshold: Nullable>> @@ -640,7 +640,7 @@ ContainerVolumeMountSpec (abstract type): ``` LifeCycleProbe: - children: LifeCycleExec, LifeCycleHTTP + children: [LifeCycleExec](#lifecycleexec), [LifeCycleHTTP](#lifecyclehttp) parent types: LifeCycle properties: @@ -735,7 +735,7 @@ DCRollingStrategy (abstract type): ``` RouteDest: - children: RouteDestService + children: [RouteDestService](#routedestservice) parent types: Route properties: weight: Positive> @@ -770,7 +770,7 @@ ServiceAccount (abstract type): ``` PodVolumeBaseSpec: - children: PodVolumeHostSpec, PodVolumeItemMapper, PodVolumePVCSpec, PodVolumeEmptyDirSpec, PodVolumeConfigMapSpec, PodVolumeSecretSpec + children: [PodVolumeHostSpec](#podvolumehostspec), [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumePVCSpec](#podvolumepvcspec), [PodVolumeEmptyDirSpec](#podvolumeemptydirspec), [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) parent types: PodTemplateSpec properties: name: Identifier @@ -861,7 +861,7 @@ ContainerProbeTCPPortSpec (abstract type): ``` ContainerEnvBaseSpec: - children: ContainerEnvSpec, ContainerEnvConfigMapSpec, ContainerEnvSecretSpec, ContainerEnvPodFieldSpec, ContainerEnvContainerResourceSpec + children: [ContainerEnvSpec](#containerenvspec), [ContainerEnvConfigMapSpec](#containerenvconfigmapspec), [ContainerEnvSecretSpec](#containerenvsecretspec), [ContainerEnvPodFieldSpec](#containerenvpodfieldspec), [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod properties: name: EnvString @@ -910,7 +910,7 @@ DCTagImages (abstract type): ``` Secret (abstract type): - children: DockerCredentials, TLSCredentials + children: [DockerCredentials](#dockercredentials), [TLSCredentials](#tlscredentials) metadata: annotations: Map labels: Map @@ -933,7 +933,7 @@ RouteDestPort (abstract type): ``` BaseSelector: - children: MatchLabelsSelector, MatchExpressionsSelector + children: [MatchLabelsSelector](#matchlabelsselector), [MatchExpressionsSelector](#matchexpressionsselector) parent types: DaemonSet, Deployment, Job, PersistentVolumeClaim properties: From 0bc11ce1f2a3950e5d36b71832d6aa69e64faec4 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 5 Jul 2018 09:53:08 +0200 Subject: [PATCH 05/40] Another test --- docs/rubiks.class.md | 1621 ++++++++++++++++++------------------------ 1 file changed, 700 insertions(+), 921 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index f9fb1d4..7e582fc 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -1,1187 +1,966 @@ ## TLSCredentials - +#### Parents: [Secret](#secret) ``` -TLSCredentials (abstract type): - parents: Secret metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - secrets: Map - tls_cert: String - tls_key: String - type: NonEmpty - ``` -## Service +#### Properties: +Name | Type | Identifier | Abstract +name | Identifier | True | False +Map | [secrets](#secrets) | False | False +String | [tls_cert](#tls_cert) | False | False +String | [tls_key](#tls_key) | False | False +NonEmpty | [type](#type) | False | False +## Service +#### Children: [ClusterIPService](#clusteripservice), [AWSLoadBalancerService](#awsloadbalancerservice) ``` -Service: - children: [ClusterIPService](#clusteripservice), [AWSLoadBalancerService](#awsloadbalancerservice) metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - *ports: NonEmpty> - *selector: NonEmpty> - sessionAffinity: Nullable - ``` -## DockerCredentials +#### Properties: +Name | Type | Identifier | Abstract +name | Identifier | True | False +NonEmpty> | [ports](#ports) | False | True +NonEmpty> | [selector](#selector) | False | True +Nullable | [sessionAffinity](#sessionaffinity) | False | False +## DockerCredentials +#### Parents: [Secret](#secret) ``` -DockerCredentials (abstract type): - parents: Secret metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - dockers: Map> - secrets: Map - type: NonEmpty - ``` -## DplBaseUpdateStrategy +#### Properties: -``` -DplBaseUpdateStrategy: - children: [DplRecreateStrategy](#dplrecreatestrategy), [DplRollingUpdateStrategy](#dplrollingupdatestrategy) - parent types: Deployment - properties: +Name | Type | Identifier | Abstract +name | Identifier | True | False +Map> | [dockers](#dockers) | False | False +Map | [secrets](#secrets) | False | False +NonEmpty | [type](#type) | False | False +## DplBaseUpdateStrategy +#### Children: [DplRecreateStrategy](#dplrecreatestrategy), [DplRollingUpdateStrategy](#dplrollingupdatestrategy) +#### Parent types: [Deployment](#deployment) +#### Properties: -``` +Name | Type | Identifier | Abstract ## Role - +#### Parents: [RoleBase](#rolebase) ``` -Role (abstract type): - parents: RoleBase metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - rules: NonEmpty> - ``` -## Group +#### Properties: +Name | Type | Identifier | Abstract +name | Identifier | True | False +NonEmpty> | [rules](#rules) | False | False +## Group ``` -Group (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - users: NonEmpty> - -``` -## RouteTLS - ``` -RouteTLS (abstract type): - parent types: Route - properties: - caCertificate: Nullable> - certificate: Nullable> - destinationCACertificate: Nullable> - insecureEdgeTerminationPolicy: Enum(u'Allow', u'Disable', u'Redirect') - key: Nullable> - termination: Enum(u'edge', u'reencrypt', u'passthrough') +#### Properties: -``` +Name | Type | Identifier | Abstract +name | Identifier | True | False +NonEmpty> | [users](#users) | False | False +## RouteTLS +#### Parent types: [Route](#route) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable> | [caCertificate](#cacertificate) | False | False +Nullable> | [certificate](#certificate) | False | False +Nullable> | [destinationCACertificate](#destinationcacertificate) | False | False +Enum(u'Allow', u'Disable', u'Redirect') | [insecureEdgeTerminationPolicy](#insecureedgeterminationpolicy) | False | False +Nullable> | [key](#key) | False | False +Enum(u'edge', u'reencrypt', u'passthrough') | [termination](#termination) | False | False ## SCCRunAsUser - -``` -SCCRunAsUser (abstract type): - parent types: SecurityContextConstraints - properties: - type: Enum(u'MustRunAs', u'RunAsAny', u'MustRunAsRange', u'MustRunAsNonRoot') - uid: Nullable>> - uidRangeMax: Nullable>> - uidRangeMin: Nullable>> - -``` +#### Parent types: [SecurityContextConstraints](#securitycontextconstraints) +#### Properties: + +Name | Type | Identifier | Abstract +Enum(u'MustRunAs', u'RunAsAny', u'MustRunAsRange', u'MustRunAsNonRoot') | [type](#type) | False | False +Nullable>> | [uid](#uid) | False | False +Nullable>> | [uidRangeMax](#uidrangemax) | False | False +Nullable>> | [uidRangeMin](#uidrangemin) | False | False ## PersistentVolumeClaim - ``` -PersistentVolumeClaim (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - accessModes: List - request: Memory - selector: Nullable - *volumeName: Nullable - ``` -## PodVolumePVCSpec +#### Properties: -``` -PodVolumePVCSpec (abstract type): - parents: PodVolumeBaseSpec - parent types: PodTemplateSpec - properties: - claimName: Identifier - name: Identifier +Name | Type | Identifier | Abstract +name | Identifier | True | False +List | [accessModes](#accessmodes) | False | False +Memory | [request](#request) | False | False +Nullable | [selector](#selector) | False | False +Nullable | [volumeName](#volumename) | False | True +## PodVolumePVCSpec +#### Parents: [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Properties: -``` +Name | Type | Identifier | Abstract +Identifier | [claimName](#claimname) | False | False +Identifier | [name](#name) | False | False ## DCConfigChangeTrigger +#### Parents: [DCTrigger](#dctrigger) +#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Properties: -``` -DCConfigChangeTrigger (abstract type): - parents: DCTrigger - parent types: DeploymentConfig - properties: - -``` +Name | Type | Identifier | Abstract ## SecurityContext - -``` -SecurityContext (abstract type): - parent types: ContainerSpec, PodTemplateSpec - properties: - fsGroup: Nullable - privileged: Nullable - runAsNonRoot: Nullable - runAsUser: Nullable - supplementalGroups: Nullable> - -``` +#### Parent types: [ContainerSpec](#containerspec), [PodTemplateSpec](#podtemplatespec) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable | [fsGroup](#fsgroup) | False | False +Nullable | [privileged](#privileged) | False | False +Nullable | [runAsNonRoot](#runasnonroot) | False | False +Nullable | [runAsUser](#runasuser) | False | False +Nullable> | [supplementalGroups](#supplementalgroups) | False | False ## Project - +#### Parents: [Namespace](#namespace) ``` -Project (abstract type): - parents: Namespace metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - ``` -## PersistentVolume +#### Properties: +Name | Type | Identifier | Abstract +name | Identifier | True | False +## PersistentVolume ``` -PersistentVolume (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - accessModes: List - awsElasticBlockStore: Nullable - capacity: Memory - claimRef: Nullable - persistentVolumeReclaimPolicy: Nullable - ``` -## DeploymentConfig +#### Properties: +Name | Type | Identifier | Abstract +name | Identifier | True | False +List | [accessModes](#accessmodes) | False | False +Nullable | [awsElasticBlockStore](#awselasticblockstore) | False | False +Memory | [capacity](#capacity) | False | False +Nullable | [claimRef](#claimref) | False | False +Nullable | [persistentVolumeReclaimPolicy](#persistentvolumereclaimpolicy) | False | False +## DeploymentConfig ``` -DeploymentConfig (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - minReadySeconds: Nullable>> - paused: Nullable - pod_template: PodTemplateSpec - replicas: Positive> - revisionHistoryLimit: Nullable>> - selector: Nullable> - strategy: DCBaseUpdateStrategy - test: Boolean - triggers: List - -``` -## ContainerPort - ``` -ContainerPort (abstract type): - parent types: ContainerSpec - properties: - containerPort: Positive> - hostIP: Nullable - hostPort: Nullable>> - name: Nullable - protocol: Enum(u'TCP', u'UDP') +#### Properties: -``` +Name | Type | Identifier | Abstract +name | Identifier | True | False +Nullable>> | [minReadySeconds](#minreadyseconds) | False | False +Nullable | [paused](#paused) | False | False +PodTemplateSpec | [pod_template](#pod_template) | False | False +Positive> | [replicas](#replicas) | False | False +Nullable>> | [revisionHistoryLimit](#revisionhistorylimit) | False | False +Nullable> | [selector](#selector) | False | False +DCBaseUpdateStrategy | [strategy](#strategy) | False | False +Boolean | [test](#test) | False | False +List | [triggers](#triggers) | False | False +## ContainerPort +#### Parent types: [ContainerSpec](#containerspec) +#### Properties: + +Name | Type | Identifier | Abstract +Positive> | [containerPort](#containerport) | False | False +Nullable | [hostIP](#hostip) | False | False +Nullable>> | [hostPort](#hostport) | False | False +Nullable | [name](#name) | False | False +Enum(u'TCP', u'UDP') | [protocol](#protocol) | False | False ## DCImageChangeTrigger +#### Parents: [DCTrigger](#dctrigger) +#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Properties: -``` -DCImageChangeTrigger (abstract type): - parents: DCTrigger - parent types: DeploymentConfig - properties: - -``` +Name | Type | Identifier | Abstract ## RoleRef +#### Parent types: [ClusterRoleBinding](#clusterrolebinding), [PolicyBindingRoleBinding](#policybindingrolebinding), [RoleBindingBase](#rolebindingbase), [RoleBinding](#rolebinding) +#### Properties: -``` -RoleRef (abstract type): - parent types: ClusterRoleBinding, PolicyBindingRoleBinding, RoleBinding, RoleBindingBase - properties: - name: Nullable - ns: Nullable - -``` +Name | Type | Identifier | Abstract +Nullable | [name](#name) | False | False +Nullable | [ns](#ns) | False | False ## LifeCycleHTTP - -``` -LifeCycleHTTP (abstract type): - parents: LifeCycleProbe - parent types: LifeCycle - properties: - path: NonEmpty - port: Positive> - scheme: Nullable - -``` +#### Parents: [LifeCycleProbe](#lifecycleprobe) +#### Parent types: [LifeCycle](#lifecycle) +#### Properties: + +Name | Type | Identifier | Abstract +NonEmpty | [path](#path) | False | False +Positive> | [port](#port) | False | False +Nullable | [scheme](#scheme) | False | False ## PodVolumeItemMapper - -``` -PodVolumeItemMapper: - parents: PodVolumeBaseSpec - children: [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) - parent types: PodTemplateSpec - properties: - item_map: Nullable> - name: Identifier - -``` +#### Parents: [PodVolumeBaseSpec](#podvolumebasespec) +#### Children: [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) +#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable> | [item_map](#item_map) | False | False +Identifier | [name](#name) | False | False ## DaemonSet - +#### Parents: [SelectorsPreProcessMixin](#selectorspreprocessmixin) ``` -DaemonSet (abstract type): - parents: SelectorsPreProcessMixin metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - pod_template: PodTemplateSpec - *selector: Nullable - ``` -## DCBaseUpdateStrategy +#### Properties: -``` -DCBaseUpdateStrategy: - children: [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy), [DCCustomStrategy](#dccustomstrategy) - parent types: DeploymentConfig - properties: - activeDeadlineSeconds: Nullable>> - annotations: Map - labels: Map - resources: Nullable - -``` +Name | Type | Identifier | Abstract +name | Identifier | True | False +PodTemplateSpec | [pod_template](#pod_template) | False | False +Nullable | [selector](#selector) | False | True +## DCBaseUpdateStrategy +#### Children: [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy), [DCCustomStrategy](#dccustomstrategy) +#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable>> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False +Map | [annotations](#annotations) | False | False +Map | [labels](#labels) | False | False +Nullable | [resources](#resources) | False | False ## Namespace - +#### Children: [Project](#project) ``` -Namespace (abstract type): - children: [Project](#project) metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - ``` -## ContainerEnvSpec +#### Properties: -``` -ContainerEnvSpec (abstract type): - parents: ContainerEnvBaseSpec - parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod - properties: - name: EnvString - value: String +Name | Type | Identifier | Abstract +name | Identifier | True | False +## ContainerEnvSpec +#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Properties: -``` +Name | Type | Identifier | Abstract +EnvString | [name](#name) | False | False +String | [value](#value) | False | False ## PodVolumeConfigMapSpec - -``` -PodVolumeConfigMapSpec (abstract type): - parents: PodVolumeItemMapper, PodVolumeBaseSpec - parent types: PodTemplateSpec - properties: - defaultMode: Nullable> - item_map: Nullable> - map_name: Identifier - name: Identifier - -``` +#### Parents: [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable> | [defaultMode](#defaultmode) | False | False +Nullable> | [item_map](#item_map) | False | False +Identifier | [map_name](#map_name) | False | False +Identifier | [name](#name) | False | False ## MatchExpression +#### Parent types: [MatchExpressionsSelector](#matchexpressionsselector) +#### Properties: -``` -MatchExpression (abstract type): - parent types: MatchExpressionsSelector - properties: - key: NonEmpty - operator: Enum(u'In', u'NotIn', u'Exists', u'DoesNotExist') - values: Nullable> - -``` +Name | Type | Identifier | Abstract +NonEmpty | [key](#key) | False | False +Enum(u'In', u'NotIn', u'Exists', u'DoesNotExist') | [operator](#operator) | False | False +Nullable> | [values](#values) | False | False ## SCCSELinux - -``` -SCCSELinux (abstract type): - parent types: SecurityContextConstraints - properties: - level: Nullable - role: Nullable - strategy: Nullable - type: Nullable - user: Nullable - -``` +#### Parent types: [SecurityContextConstraints](#securitycontextconstraints) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable | [level](#level) | False | False +Nullable | [role](#role) | False | False +Nullable | [strategy](#strategy) | False | False +Nullable | [type](#type) | False | False +Nullable | [user](#user) | False | False ## ClusterRoleBinding - +#### Parents: [RoleBindingBase](#rolebindingbase), [RoleBindingXF](#rolebindingxf) ``` -ClusterRoleBinding (abstract type): - parents: RoleBindingBase, RoleBindingXF metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - *roleRef: RoleRef - *subjects: NonEmpty> - ``` -## AWSLoadBalancerService +#### Properties: +Name | Type | Identifier | Abstract +name | Identifier | True | False +RoleRef | [roleRef](#roleref) | False | True +NonEmpty> | [subjects](#subjects) | False | True +## AWSLoadBalancerService +#### Parents: [Service](#service) ``` -AWSLoadBalancerService (abstract type): - parents: Service metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - aws-load-balancer-backend-protocol: Nullable - aws-load-balancer-ssl-cert: Nullable - externalTrafficPolicy: Nullable - *ports: NonEmpty> - *selector: NonEmpty> - sessionAffinity: Nullable - ``` -## Job +#### Properties: +Name | Type | Identifier | Abstract +name | Identifier | True | False +Nullable | [aws-load-balancer-backend-protocol](#aws-load-balancer-backend-protocol) | False | False +Nullable | [aws-load-balancer-ssl-cert](#aws-load-balancer-ssl-cert) | False | False +Nullable | [externalTrafficPolicy](#externaltrafficpolicy) | False | False +NonEmpty> | [ports](#ports) | False | True +NonEmpty> | [selector](#selector) | False | True +Nullable | [sessionAffinity](#sessionaffinity) | False | False +## Job ``` -Job (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - activeDeadlineSeconds: Nullable> - completions: Nullable>> - manualSelector: Nullable - parallelism: Nullable>> - pod_template: PodTemplateSpec - selector: Nullable - ``` -## RouteDestService +#### Properties: -``` -RouteDestService (abstract type): - parents: RouteDest - parent types: Route - properties: - name: Identifier - weight: Positive> +Name | Type | Identifier | Abstract +name | Identifier | True | False +Nullable> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False +Nullable>> | [completions](#completions) | False | False +Nullable | [manualSelector](#manualselector) | False | False +Nullable>> | [parallelism](#parallelism) | False | False +PodTemplateSpec | [pod_template](#pod_template) | False | False +Nullable | [selector](#selector) | False | False +## RouteDestService +#### Parents: [RouteDest](#routedest) +#### Parent types: [Route](#route) +#### Properties: -``` +Name | Type | Identifier | Abstract +Identifier | [name](#name) | False | False +Positive> | [weight](#weight) | False | False ## DCRecreateStrategy - -``` -DCRecreateStrategy (abstract type): - parents: DCBaseUpdateStrategy - parent types: DeploymentConfig - properties: - activeDeadlineSeconds: Nullable>> - annotations: Map - customParams: Nullable - labels: Map - recreateParams: Nullable - resources: Nullable - -``` +#### Parents: [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable>> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False +Map | [annotations](#annotations) | False | False +Nullable | [customParams](#customparams) | False | False +Map | [labels](#labels) | False | False +Nullable | [recreateParams](#recreateparams) | False | False +Nullable | [resources](#resources) | False | False ## DplRollingUpdateStrategy +#### Parents: [DplBaseUpdateStrategy](#dplbaseupdatestrategy) +#### Parent types: [Deployment](#deployment) +#### Properties: -``` -DplRollingUpdateStrategy (abstract type): - parents: DplBaseUpdateStrategy - parent types: Deployment - properties: - maxSurge: SurgeSpec - maxUnavailable: SurgeSpec - -``` +Name | Type | Identifier | Abstract +SurgeSpec | [maxSurge](#maxsurge) | False | False +SurgeSpec | [maxUnavailable](#maxunavailable) | False | False ## ContainerSpec - -``` -ContainerSpec (abstract type): - parents: EnvironmentPreProcessMixin - parent types: PodTemplateSpec - properties: - name (identifier): Identifier - args: Nullable> - command: Nullable> - *env: Nullable> - image: NonEmpty - imagePullPolicy: Nullable - kind: Nullable - lifecycle: Nullable - livenessProbe: Nullable - *ports: Nullable> - readinessProbe: Nullable - resources: Nullable - securityContext: Nullable - terminationMessagePath: Nullable> - *volumeMounts: Nullable> - -``` +#### Parents: [EnvironmentPreProcessMixin](#environmentpreprocessmixin) +#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Properties: + +Name | Type | Identifier | Abstract +name | Identifier | True | False +Nullable> | [args](#args) | False | False +Nullable> | [command](#command) | False | False +Nullable> | [env](#env) | False | True +NonEmpty | [image](#image) | False | False +Nullable | [imagePullPolicy](#imagepullpolicy) | False | False +Nullable | [kind](#kind) | False | False +Nullable | [lifecycle](#lifecycle) | False | False +Nullable | [livenessProbe](#livenessprobe) | False | False +Nullable> | [ports](#ports) | False | True +Nullable | [readinessProbe](#readinessprobe) | False | False +Nullable | [resources](#resources) | False | False +Nullable | [securityContext](#securitycontext) | False | False +Nullable> | [terminationMessagePath](#terminationmessagepath) | False | False +Nullable> | [volumeMounts](#volumemounts) | False | True ## DplRecreateStrategy +#### Parents: [DplBaseUpdateStrategy](#dplbaseupdatestrategy) +#### Parent types: [Deployment](#deployment) +#### Properties: -``` -DplRecreateStrategy (abstract type): - parents: DplBaseUpdateStrategy - parent types: Deployment - properties: - -``` +Name | Type | Identifier | Abstract ## DCTrigger +#### Children: [DCConfigChangeTrigger](#dcconfigchangetrigger), [DCImageChangeTrigger](#dcimagechangetrigger) +#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Properties: -``` -DCTrigger: - children: [DCConfigChangeTrigger](#dcconfigchangetrigger), [DCImageChangeTrigger](#dcimagechangetrigger) - parent types: DeploymentConfig - properties: - -``` +Name | Type | Identifier | Abstract ## ContainerEnvSecretSpec - -``` -ContainerEnvSecretSpec (abstract type): - parents: ContainerEnvBaseSpec - parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod - properties: - key: NonEmpty - name: EnvString - secret_name: Identifier - -``` +#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Properties: + +Name | Type | Identifier | Abstract +NonEmpty | [key](#key) | False | False +EnvString | [name](#name) | False | False +Identifier | [secret_name](#secret_name) | False | False ## MatchExpressionsSelector +#### Parents: [BaseSelector](#baseselector) +#### Parent types: [DaemonSet](#daemonset), [Deployment](#deployment), [Job](#job), [PersistentVolumeClaim](#persistentvolumeclaim) +#### Properties: -``` -MatchExpressionsSelector (abstract type): - parents: BaseSelector - parent types: DaemonSet, Deployment, Job, PersistentVolumeClaim - properties: - matchExpressions: NonEmpty> - -``` +Name | Type | Identifier | Abstract +NonEmpty> | [matchExpressions](#matchexpressions) | False | False ## ContainerProbeBaseSpec - -``` -ContainerProbeBaseSpec: - children: [ContainerProbeTCPPortSpec](#containerprobetcpportspec), [ContainerProbeHTTPSpec](#containerprobehttpspec) - parent types: ContainerSpec - properties: - failureThreshold: Nullable>> - initialDelaySeconds: Nullable> - periodSeconds: Nullable>> - successThreshold: Nullable>> - timeoutSeconds: Nullable>> - -``` +#### Children: [ContainerProbeTCPPortSpec](#containerprobetcpportspec), [ContainerProbeHTTPSpec](#containerprobehttpspec) +#### Parent types: [ContainerSpec](#containerspec) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable>> | [failureThreshold](#failurethreshold) | False | False +Nullable> | [initialDelaySeconds](#initialdelayseconds) | False | False +Nullable>> | [periodSeconds](#periodseconds) | False | False +Nullable>> | [successThreshold](#successthreshold) | False | False +Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False ## PodVolumeEmptyDirSpec +#### Parents: [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Properties: -``` -PodVolumeEmptyDirSpec (abstract type): - parents: PodVolumeBaseSpec - parent types: PodTemplateSpec - properties: - name: Identifier - -``` +Name | Type | Identifier | Abstract +Identifier | [name](#name) | False | False ## PolicyBinding - ``` -PolicyBinding (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): ColonIdentifier - *roleBindings: List - ``` -## ConfigMap +#### Properties: +Name | Type | Identifier | Abstract +name | ColonIdentifier | True | False +List | [roleBindings](#rolebindings) | False | True +## ConfigMap ``` -ConfigMap (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - files: Map - ``` -## SCCGroups +#### Properties: -``` -SCCGroups (abstract type): - parent types: SecurityContextConstraints - properties: - ranges: Nullable> - type: Nullable +Name | Type | Identifier | Abstract +name | Identifier | True | False +Map | [files](#files) | False | False +## SCCGroups +#### Parent types: [SecurityContextConstraints](#securitycontextconstraints) +#### Properties: -``` +Name | Type | Identifier | Abstract +Nullable> | [ranges](#ranges) | False | False +Nullable | [type](#type) | False | False ## DCCustomStrategy - -``` -DCCustomStrategy (abstract type): - parents: DCBaseUpdateStrategy - parent types: DeploymentConfig - properties: - activeDeadlineSeconds: Nullable>> - annotations: Map - customParams: DCCustomParams - labels: Map - resources: Nullable - -``` +#### Parents: [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable>> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False +Map | [annotations](#annotations) | False | False +DCCustomParams | [customParams](#customparams) | False | False +Map | [labels](#labels) | False | False +Nullable | [resources](#resources) | False | False ## ContainerResourceEachSpec +#### Parent types: [ContainerResourceSpec](#containerresourcespec) +#### Properties: -``` -ContainerResourceEachSpec (abstract type): - parent types: ContainerResourceSpec - properties: - *cpu: Nullable>> - memory: Nullable - -``` +Name | Type | Identifier | Abstract +Nullable>> | [cpu](#cpu) | False | True +Nullable | [memory](#memory) | False | False ## StorageClass - ``` -StorageClass (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - parameters: Map - provisioner: String - ``` -## DCRollingParams - -``` -DCRollingParams (abstract type): - parent types: DCRollingStrategy - properties: - intervalSeconds: Nullable>> - maxSurge: SurgeSpec - maxUnavailable: SurgeSpec - post: Nullable - pre: Nullable - timeoutSeconds: Nullable>> - updatePeriodSeconds: Nullable>> +#### Properties: -``` +Name | Type | Identifier | Abstract +name | Identifier | True | False +Map | [parameters](#parameters) | False | False +String | [provisioner](#provisioner) | False | False +## DCRollingParams +#### Parent types: [DCRollingStrategy](#dcrollingstrategy) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable>> | [intervalSeconds](#intervalseconds) | False | False +SurgeSpec | [maxSurge](#maxsurge) | False | False +SurgeSpec | [maxUnavailable](#maxunavailable) | False | False +Nullable | [post](#post) | False | False +Nullable | [pre](#pre) | False | False +Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False +Nullable>> | [updatePeriodSeconds](#updateperiodseconds) | False | False ## SCCGroupRange +#### Parent types: [SCCGroups](#sccgroups) +#### Properties: -``` -SCCGroupRange (abstract type): - parent types: SCCGroups - properties: - max: Positive> - min: Positive> - -``` +Name | Type | Identifier | Abstract +Positive> | [max](#max) | False | False +Positive> | [min](#min) | False | False ## DCCustomParams - -``` -DCCustomParams (abstract type): - parents: EnvironmentPreProcessMixin - parent types: DCCustomStrategy, DCRecreateStrategy, DCRollingStrategy - properties: - command: Nullable> - *environment: Nullable> - image: NonEmpty - -``` +#### Parents: [EnvironmentPreProcessMixin](#environmentpreprocessmixin) +#### Parent types: [DCCustomStrategy](#dccustomstrategy), [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable> | [command](#command) | False | False +Nullable> | [environment](#environment) | False | True +NonEmpty | [image](#image) | False | False ## ContainerVolumeMountSpec +#### Parent types: [ContainerSpec](#containerspec), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Properties: -``` -ContainerVolumeMountSpec (abstract type): - parent types: ContainerSpec, DCLifecycleNewPod - properties: - name: Identifier - path: NonEmpty - readOnly: Nullable - -``` +Name | Type | Identifier | Abstract +Identifier | [name](#name) | False | False +NonEmpty | [path](#path) | False | False +Nullable | [readOnly](#readonly) | False | False ## LifeCycleProbe +#### Children: [LifeCycleExec](#lifecycleexec), [LifeCycleHTTP](#lifecyclehttp) +#### Parent types: [LifeCycle](#lifecycle) +#### Properties: -``` -LifeCycleProbe: - children: [LifeCycleExec](#lifecycleexec), [LifeCycleHTTP](#lifecyclehttp) - parent types: LifeCycle - properties: - -``` +Name | Type | Identifier | Abstract ## SASecretSubject +#### Parent types: [ServiceAccount](#serviceaccount) +#### Properties: -``` -SASecretSubject (abstract type): - parent types: ServiceAccount - properties: - kind: Nullable - name: Nullable - ns: Nullable - -``` +Name | Type | Identifier | Abstract +Nullable | [kind](#kind) | False | False +Nullable | [name](#name) | False | False +Nullable | [ns](#ns) | False | False ## PodTemplateSpec - +#### Parent types: [DaemonSet](#daemonset), [DeploymentConfig](#deploymentconfig), [Deployment](#deployment), [Job](#job), [ReplicationController](#replicationcontroller) ``` -PodTemplateSpec (abstract type): - parent types: DaemonSet, Deployment, DeploymentConfig, Job, ReplicationController metadata: annotations: Map labels: Map - properties: - containers: NonEmpty> - dnsPolicy: Nullable - hostIPC: Nullable - hostNetwork: Nullable - hostPID: Nullable - *imagePullSecrets: Nullable> - name: Nullable - nodeSelector: Nullable> - restartPolicy: Nullable - securityContext: Nullable - *serviceAccountName: Nullable - (serviceAccount) - terminationGracePeriodSeconds: Nullable> - volumes: Nullable> - ``` -## User +#### Properties: +Name | Type | Identifier | Abstract +NonEmpty> | [containers](#containers) | False | False +Nullable | [dnsPolicy](#dnspolicy) | False | False +Nullable | [hostIPC](#hostipc) | False | False +Nullable | [hostNetwork](#hostnetwork) | False | False +Nullable | [hostPID](#hostpid) | False | False +Nullable> | [imagePullSecrets](#imagepullsecrets) | False | True +Nullable | [name](#name) | False | False +Nullable> | [nodeSelector](#nodeselector) | False | False +Nullable | [restartPolicy](#restartpolicy) | False | False +Nullable | [securityContext](#securitycontext) | False | False +Nullable | [serviceAccountName](#serviceaccountname) | False | True +Nullable> | [terminationGracePeriodSeconds](#terminationgraceperiodseconds) | False | False +Nullable> | [volumes](#volumes) | False | False +## User ``` -User (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): UserIdentifier - fullName: Nullable - identities: NonEmpty>> - ``` -## ContainerEnvConfigMapSpec +#### Properties: -``` -ContainerEnvConfigMapSpec (abstract type): - parents: ContainerEnvBaseSpec - parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod - properties: - key: NonEmpty - map_name: Identifier - name: EnvString - -``` +Name | Type | Identifier | Abstract +name | UserIdentifier | True | False +Nullable | [fullName](#fullname) | False | False +NonEmpty>> | [identities](#identities) | False | False +## ContainerEnvConfigMapSpec +#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Properties: + +Name | Type | Identifier | Abstract +NonEmpty | [key](#key) | False | False +Identifier | [map_name](#map_name) | False | False +EnvString | [name](#name) | False | False ## LifeCycleExec +#### Parents: [LifeCycleProbe](#lifecycleprobe) +#### Parent types: [LifeCycle](#lifecycle) +#### Properties: -``` -LifeCycleExec (abstract type): - parents: LifeCycleProbe - parent types: LifeCycle - properties: - command: NonEmpty> - -``` +Name | Type | Identifier | Abstract +NonEmpty> | [command](#command) | False | False ## DCRollingStrategy - -``` -DCRollingStrategy (abstract type): - parents: DCBaseUpdateStrategy - parent types: DeploymentConfig - properties: - activeDeadlineSeconds: Nullable>> - annotations: Map - customParams: Nullable - labels: Map - resources: Nullable - rollingParams: Nullable - -``` +#### Parents: [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable>> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False +Map | [annotations](#annotations) | False | False +Nullable | [customParams](#customparams) | False | False +Map | [labels](#labels) | False | False +Nullable | [resources](#resources) | False | False +Nullable | [rollingParams](#rollingparams) | False | False ## RouteDest +#### Children: [RouteDestService](#routedestservice) +#### Parent types: [Route](#route) +#### Properties: -``` -RouteDest: - children: [RouteDestService](#routedestservice) - parent types: Route - properties: - weight: Positive> - -``` +Name | Type | Identifier | Abstract +Positive> | [weight](#weight) | False | False ## ContainerEnvPodFieldSpec - -``` -ContainerEnvPodFieldSpec (abstract type): - parents: ContainerEnvBaseSpec - parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod - properties: - apiVersion: Nullable - fieldPath: Enum(u'metadata.name', u'metadata.namespace', u'metadata.labels', u'metadata.annotations', u'spec.nodeName', u'spec.serviceAccountName', u'status.podIP') - name: EnvString - -``` +#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable | [apiVersion](#apiversion) | False | False +Enum(u'metadata.name', u'metadata.namespace', u'metadata.labels', u'metadata.annotations', u'spec.nodeName', u'spec.serviceAccountName', u'status.podIP') | [fieldPath](#fieldpath) | False | False +EnvString | [name](#name) | False | False ## ServiceAccount - ``` -ServiceAccount (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - *imagePullSecrets: Nullable> - *secrets: Nullable> - ``` -## PodVolumeBaseSpec +#### Properties: -``` -PodVolumeBaseSpec: - children: [PodVolumeHostSpec](#podvolumehostspec), [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumePVCSpec](#podvolumepvcspec), [PodVolumeEmptyDirSpec](#podvolumeemptydirspec), [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) - parent types: PodTemplateSpec - properties: - name: Identifier +Name | Type | Identifier | Abstract +name | Identifier | True | False +Nullable> | [imagePullSecrets](#imagepullsecrets) | False | True +Nullable> | [secrets](#secrets) | False | True +## PodVolumeBaseSpec +#### Children: [PodVolumeHostSpec](#podvolumehostspec), [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumePVCSpec](#podvolumepvcspec), [PodVolumeEmptyDirSpec](#podvolumeemptydirspec), [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) +#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Properties: -``` +Name | Type | Identifier | Abstract +Identifier | [name](#name) | False | False ## ClusterRole - +#### Parents: [RoleBase](#rolebase) ``` -ClusterRole (abstract type): - parents: RoleBase metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - rules: NonEmpty> - ``` -## DCLifecycleHook +#### Properties: -``` -DCLifecycleHook (abstract type): - parent types: DCRecreateParams, DCRollingParams - properties: - execNewPod: Nullable - failurePolicy: Enum(u'Abort', u'Retry', u'Ignore') - tagImages: Nullable +Name | Type | Identifier | Abstract +name | Identifier | True | False +NonEmpty> | [rules](#rules) | False | False +## DCLifecycleHook +#### Parent types: [DCRecreateParams](#dcrecreateparams), [DCRollingParams](#dcrollingparams) +#### Properties: -``` +Name | Type | Identifier | Abstract +Nullable | [execNewPod](#execnewpod) | False | False +Enum(u'Abort', u'Retry', u'Ignore') | [failurePolicy](#failurepolicy) | False | False +Nullable | [tagImages](#tagimages) | False | False ## ClusterIPService - +#### Parents: [Service](#service) ``` -ClusterIPService (abstract type): - parents: Service metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - clusterIP: Nullable - *ports: NonEmpty> - *selector: NonEmpty> - sessionAffinity: Nullable - -``` -## PersistentVolumeRef - ``` -PersistentVolumeRef (abstract type): - parent types: PersistentVolume - properties: - apiVersion: Nullable - kind: Nullable - name: Nullable - ns: Nullable +#### Properties: -``` +Name | Type | Identifier | Abstract +name | Identifier | True | False +Nullable | [clusterIP](#clusterip) | False | False +NonEmpty> | [ports](#ports) | False | True +NonEmpty> | [selector](#selector) | False | True +Nullable | [sessionAffinity](#sessionaffinity) | False | False +## PersistentVolumeRef +#### Parent types: [PersistentVolume](#persistentvolume) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable | [apiVersion](#apiversion) | False | False +Nullable | [kind](#kind) | False | False +Nullable | [name](#name) | False | False +Nullable | [ns](#ns) | False | False ## DCLifecycleNewPod - -``` -DCLifecycleNewPod (abstract type): - parents: EnvironmentPreProcessMixin - parent types: DCLifecycleHook - properties: - command: NonEmpty> - containerName: Identifier - *env: Nullable> - volumeMounts: Nullable> - volumes: Nullable> - -``` +#### Parents: [EnvironmentPreProcessMixin](#environmentpreprocessmixin) +#### Parent types: [DCLifecycleHook](#dclifecyclehook) +#### Properties: + +Name | Type | Identifier | Abstract +NonEmpty> | [command](#command) | False | False +Identifier | [containerName](#containername) | False | False +Nullable> | [env](#env) | False | True +Nullable> | [volumeMounts](#volumemounts) | False | False +Nullable> | [volumes](#volumes) | False | False ## ContainerProbeTCPPortSpec - -``` -ContainerProbeTCPPortSpec (abstract type): - parents: ContainerProbeBaseSpec - parent types: ContainerSpec - properties: - failureThreshold: Nullable>> - initialDelaySeconds: Nullable> - periodSeconds: Nullable>> - *port: Positive> - successThreshold: Nullable>> - timeoutSeconds: Nullable>> - -``` +#### Parents: [ContainerProbeBaseSpec](#containerprobebasespec) +#### Parent types: [ContainerSpec](#containerspec) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable>> | [failureThreshold](#failurethreshold) | False | False +Nullable> | [initialDelaySeconds](#initialdelayseconds) | False | False +Nullable>> | [periodSeconds](#periodseconds) | False | False +Positive> | [port](#port) | False | True +Nullable>> | [successThreshold](#successthreshold) | False | False +Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False ## ContainerEnvBaseSpec +#### Children: [ContainerEnvSpec](#containerenvspec), [ContainerEnvConfigMapSpec](#containerenvconfigmapspec), [ContainerEnvSecretSpec](#containerenvsecretspec), [ContainerEnvPodFieldSpec](#containerenvpodfieldspec), [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) +#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Properties: -``` -ContainerEnvBaseSpec: - children: [ContainerEnvSpec](#containerenvspec), [ContainerEnvConfigMapSpec](#containerenvconfigmapspec), [ContainerEnvSecretSpec](#containerenvsecretspec), [ContainerEnvPodFieldSpec](#containerenvpodfieldspec), [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) - parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod - properties: - name: EnvString - -``` +Name | Type | Identifier | Abstract +EnvString | [name](#name) | False | False ## PodVolumeHostSpec +#### Parents: [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Properties: -``` -PodVolumeHostSpec (abstract type): - parents: PodVolumeBaseSpec - parent types: PodTemplateSpec - properties: - name: Identifier - path: String - -``` +Name | Type | Identifier | Abstract +Identifier | [name](#name) | False | False +String | [path](#path) | False | False ## DCRecreateParams - -``` -DCRecreateParams (abstract type): - parent types: DCRecreateStrategy - properties: - mid: Nullable - post: Nullable - pre: Nullable - timeoutSeconds: Nullable>> - -``` +#### Parent types: [DCRecreateStrategy](#dcrecreatestrategy) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable | [mid](#mid) | False | False +Nullable | [post](#post) | False | False +Nullable | [pre](#pre) | False | False +Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False ## DCTagImages - -``` -DCTagImages (abstract type): - parent types: DCLifecycleHook - properties: - containerName: Identifier - toApiVersion: Nullable - toFieldPath: Nullable - toKind: Nullable - toName: Nullable - toNamespace: Nullable - toResourceVersion: Nullable - toUid: Nullable - -``` +#### Parent types: [DCLifecycleHook](#dclifecyclehook) +#### Properties: + +Name | Type | Identifier | Abstract +Identifier | [containerName](#containername) | False | False +Nullable | [toApiVersion](#toapiversion) | False | False +Nullable | [toFieldPath](#tofieldpath) | False | False +Nullable | [toKind](#tokind) | False | False +Nullable | [toName](#toname) | False | False +Nullable | [toNamespace](#tonamespace) | False | False +Nullable | [toResourceVersion](#toresourceversion) | False | False +Nullable | [toUid](#touid) | False | False ## Secret - +#### Children: [DockerCredentials](#dockercredentials), [TLSCredentials](#tlscredentials) ``` -Secret (abstract type): - children: [DockerCredentials](#dockercredentials), [TLSCredentials](#tlscredentials) metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - secrets: Map - type: NonEmpty - ``` -## RouteDestPort +#### Properties: -``` -RouteDestPort (abstract type): - parent types: Route - properties: - targetPort: Identifier +Name | Type | Identifier | Abstract +name | Identifier | True | False +Map | [secrets](#secrets) | False | False +NonEmpty | [type](#type) | False | False +## RouteDestPort +#### Parent types: [Route](#route) +#### Properties: -``` +Name | Type | Identifier | Abstract +Identifier | [targetPort](#targetport) | False | False ## BaseSelector +#### Children: [MatchLabelsSelector](#matchlabelsselector), [MatchExpressionsSelector](#matchexpressionsselector) +#### Parent types: [DaemonSet](#daemonset), [Deployment](#deployment), [Job](#job), [PersistentVolumeClaim](#persistentvolumeclaim) +#### Properties: -``` -BaseSelector: - children: [MatchLabelsSelector](#matchlabelsselector), [MatchExpressionsSelector](#matchexpressionsselector) - parent types: DaemonSet, Deployment, Job, PersistentVolumeClaim - properties: - -``` +Name | Type | Identifier | Abstract ## ContainerProbeHTTPSpec - -``` -ContainerProbeHTTPSpec (abstract type): - parents: ContainerProbeBaseSpec - parent types: ContainerSpec - properties: - failureThreshold: Nullable>> - host: Nullable - initialDelaySeconds: Nullable> - path: NonEmpty - periodSeconds: Nullable>> - *port: Positive> - scheme: Nullable - successThreshold: Nullable>> - timeoutSeconds: Nullable>> - -``` +#### Parents: [ContainerProbeBaseSpec](#containerprobebasespec) +#### Parent types: [ContainerSpec](#containerspec) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable>> | [failureThreshold](#failurethreshold) | False | False +Nullable | [host](#host) | False | False +Nullable> | [initialDelaySeconds](#initialdelayseconds) | False | False +NonEmpty | [path](#path) | False | False +Nullable>> | [periodSeconds](#periodseconds) | False | False +Positive> | [port](#port) | False | True +Nullable | [scheme](#scheme) | False | False +Nullable>> | [successThreshold](#successthreshold) | False | False +Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False ## ServicePort - -``` -ServicePort (abstract type): - parent types: AWSLoadBalancerService, ClusterIPService, Service - properties: - name: Nullable - port: Positive> - protocol: Enum(u'TCP', u'UDP') - targetPort: OneOf>, Identifier> - -``` +#### Parent types: [AWSLoadBalancerService](#awsloadbalancerservice), [ClusterIPService](#clusteripservice), [Service](#service) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable | [name](#name) | False | False +Positive> | [port](#port) | False | False +Enum(u'TCP', u'UDP') | [protocol](#protocol) | False | False +OneOf>, Identifier> | [targetPort](#targetport) | False | False ## AWSElasticBlockStore +#### Parent types: [PersistentVolume](#persistentvolume) +#### Properties: -``` -AWSElasticBlockStore (abstract type): - parent types: PersistentVolume - properties: - fsType: Enum(u'ext4') - volumeID: AWSVolID - -``` +Name | Type | Identifier | Abstract +Enum(u'ext4') | [fsType](#fstype) | False | False +AWSVolID | [volumeID](#volumeid) | False | False ## ReplicationController - ``` -ReplicationController (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - minReadySeconds: Nullable>> - pod_template: PodTemplateSpec - replicas: Positive> - selector: Nullable> - ``` -## SAImgPullSecretSubject +#### Properties: -``` -SAImgPullSecretSubject (abstract type): - parent types: ServiceAccount - properties: - name: Identifier +Name | Type | Identifier | Abstract +name | Identifier | True | False +Nullable>> | [minReadySeconds](#minreadyseconds) | False | False +PodTemplateSpec | [pod_template](#pod_template) | False | False +Positive> | [replicas](#replicas) | False | False +Nullable> | [selector](#selector) | False | False +## SAImgPullSecretSubject +#### Parent types: [ServiceAccount](#serviceaccount) +#### Properties: -``` +Name | Type | Identifier | Abstract +Identifier | [name](#name) | False | False ## Deployment - ``` -Deployment (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - minReadySeconds: Nullable>> - paused: Nullable - pod_template: PodTemplateSpec - progressDeadlineSeconds: Nullable>> - replicas: Positive> - revisionHistoryLimit: Nullable>> - selector: Nullable - strategy: Nullable - ``` -## PodImagePullSecret +#### Properties: -``` -PodImagePullSecret (abstract type): - parent types: PodTemplateSpec - properties: - name: Identifier +Name | Type | Identifier | Abstract +name | Identifier | True | False +Nullable>> | [minReadySeconds](#minreadyseconds) | False | False +Nullable | [paused](#paused) | False | False +PodTemplateSpec | [pod_template](#pod_template) | False | False +Nullable>> | [progressDeadlineSeconds](#progressdeadlineseconds) | False | False +Positive> | [replicas](#replicas) | False | False +Nullable>> | [revisionHistoryLimit](#revisionhistorylimit) | False | False +Nullable | [selector](#selector) | False | False +Nullable | [strategy](#strategy) | False | False +## PodImagePullSecret +#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Properties: -``` +Name | Type | Identifier | Abstract +Identifier | [name](#name) | False | False ## RoleSubject +#### Parent types: [ClusterRoleBinding](#clusterrolebinding), [PolicyBindingRoleBinding](#policybindingrolebinding), [RoleBindingBase](#rolebindingbase), [RoleBinding](#rolebinding) +#### Properties: -``` -RoleSubject (abstract type): - parent types: ClusterRoleBinding, PolicyBindingRoleBinding, RoleBinding, RoleBindingBase - properties: - kind: CaseIdentifier - name: String - ns: Nullable - -``` +Name | Type | Identifier | Abstract +CaseIdentifier | [kind](#kind) | False | False +String | [name](#name) | False | False +Nullable | [ns](#ns) | False | False ## SecurityContextConstraints - ``` -SecurityContextConstraints (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - allowHostDirVolumePlugin: Boolean - allowHostIPC: Boolean - allowHostNetwork: Boolean - allowHostPID: Boolean - allowHostPorts: Boolean - allowPrivilegedContainer: Boolean - allowedCapabilities: Nullable> - defaultAddCapabilities: Nullable> - fsGroup: Nullable - groups: List - priority: Nullable> - readOnlyRootFilesystem: Boolean - requiredDropCapabilities: Nullable> - runAsUser: Nullable - seLinuxContext: Nullable - seccompProfiles: Nullable> - supplementalGroups: Nullable - users: List - volumes: List - ``` +#### Properties: + +Name | Type | Identifier | Abstract +name | Identifier | True | False +Boolean | [allowHostDirVolumePlugin](#allowhostdirvolumeplugin) | False | False +Boolean | [allowHostIPC](#allowhostipc) | False | False +Boolean | [allowHostNetwork](#allowhostnetwork) | False | False +Boolean | [allowHostPID](#allowhostpid) | False | False +Boolean | [allowHostPorts](#allowhostports) | False | False +Boolean | [allowPrivilegedContainer](#allowprivilegedcontainer) | False | False +Nullable> | [allowedCapabilities](#allowedcapabilities) | False | False +Nullable> | [defaultAddCapabilities](#defaultaddcapabilities) | False | False +Nullable | [fsGroup](#fsgroup) | False | False +List | [groups](#groups) | False | False +Nullable> | [priority](#priority) | False | False +Boolean | [readOnlyRootFilesystem](#readonlyrootfilesystem) | False | False +Nullable> | [requiredDropCapabilities](#requireddropcapabilities) | False | False +Nullable | [runAsUser](#runasuser) | False | False +Nullable | [seLinuxContext](#selinuxcontext) | False | False +Nullable> | [seccompProfiles](#seccompprofiles) | False | False +Nullable | [supplementalGroups](#supplementalgroups) | False | False +List | [users](#users) | False | False +List | [volumes](#volumes) | False | False ## Route - ``` -Route (abstract type): metadata: annotations: Map labels: Map - properties: - name (identifier): Identifier - host: Domain - port: RouteDestPort - tls: Nullable - to: NonEmpty> - wildcardPolicy: Enum(u'Subdomain', u'None') - ``` -## ContainerResourceSpec +#### Properties: -``` -ContainerResourceSpec (abstract type): - parent types: ContainerSpec, DCBaseUpdateStrategy, DCCustomStrategy, DCRecreateStrategy, DCRollingStrategy - properties: - limits: ContainerResourceEachSpec - requests: ContainerResourceEachSpec +Name | Type | Identifier | Abstract +name | Identifier | True | False +Domain | [host](#host) | False | False +RouteDestPort | [port](#port) | False | False +Nullable | [tls](#tls) | False | False +NonEmpty> | [to](#to) | False | False +Enum(u'Subdomain', u'None') | [wildcardPolicy](#wildcardpolicy) | False | False +## ContainerResourceSpec +#### Parent types: [ContainerSpec](#containerspec), [DCBaseUpdateStrategy](#dcbaseupdatestrategy), [DCCustomStrategy](#dccustomstrategy), [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy) +#### Properties: -``` +Name | Type | Identifier | Abstract +ContainerResourceEachSpec | [limits](#limits) | False | False +ContainerResourceEachSpec | [requests](#requests) | False | False ## PolicyBindingRoleBinding - -``` -PolicyBindingRoleBinding (abstract type): - parents: RoleBindingXF - parent types: PolicyBinding - properties: - metadata: Nullable> - name: SystemIdentifier - ns: Identifier - *roleRef: RoleRef - *subjects: NonEmpty> - -``` +#### Parents: [RoleBindingXF](#rolebindingxf) +#### Parent types: [PolicyBinding](#policybinding) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable> | [metadata](#metadata) | False | False +SystemIdentifier | [name](#name) | False | False +Identifier | [ns](#ns) | False | False +RoleRef | [roleRef](#roleref) | False | True +NonEmpty> | [subjects](#subjects) | False | True ## LifeCycle +#### Parent types: [ContainerSpec](#containerspec) +#### Properties: -``` -LifeCycle (abstract type): - parent types: ContainerSpec - properties: - postStart: Nullable - preStop: Nullable - -``` +Name | Type | Identifier | Abstract +Nullable | [postStart](#poststart) | False | False +Nullable | [preStop](#prestop) | False | False ## RoleBinding - +#### Parents: [RoleBindingBase](#rolebindingbase), [RoleBindingXF](#rolebindingxf) ``` -RoleBinding (abstract type): - parents: RoleBindingBase, RoleBindingXF metadata: annotations: Map labels: Map - properties: - name (identifier): SystemIdentifier - *roleRef: RoleRef - *subjects: NonEmpty> - ``` -## MatchLabelsSelector +#### Properties: -``` -MatchLabelsSelector (abstract type): - parents: BaseSelector - parent types: DaemonSet, Deployment, Job, PersistentVolumeClaim - properties: - matchLabels: Map +Name | Type | Identifier | Abstract +name | SystemIdentifier | True | False +RoleRef | [roleRef](#roleref) | False | True +NonEmpty> | [subjects](#subjects) | False | True +## MatchLabelsSelector +#### Parents: [BaseSelector](#baseselector) +#### Parent types: [DaemonSet](#daemonset), [Deployment](#deployment), [Job](#job), [PersistentVolumeClaim](#persistentvolumeclaim) +#### Properties: -``` +Name | Type | Identifier | Abstract +Map | [matchLabels](#matchlabels) | False | False ## PolicyRule - -``` -PolicyRule (abstract type): - parent types: ClusterRole, Role, RoleBase - properties: - apiGroups: NonEmpty> - attributeRestrictions: Nullable - nonResourceURLs: Nullable> - resourceNames: Nullable> - resources: NonEmpty>> - verbs: NonEmpty> - -``` +#### Parent types: [ClusterRole](#clusterrole), [RoleBase](#rolebase), [Role](#role) +#### Properties: + +Name | Type | Identifier | Abstract +NonEmpty> | [apiGroups](#apigroups) | False | False +Nullable | [attributeRestrictions](#attributerestrictions) | False | False +Nullable> | [nonResourceURLs](#nonresourceurls) | False | False +Nullable> | [resourceNames](#resourcenames) | False | False +NonEmpty>> | [resources](#resources) | False | False +NonEmpty> | [verbs](#verbs) | False | False ## ContainerEnvContainerResourceSpec - -``` -ContainerEnvContainerResourceSpec (abstract type): - parents: ContainerEnvBaseSpec - parent types: ContainerSpec, DCCustomParams, DCLifecycleNewPod - properties: - containerName: Nullable - divisor: Nullable> - name: EnvString - resource: Enum(u'limits.cpu', u'limits.memory', u'requests.cpu', u'requests.memory') - -``` +#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable | [containerName](#containername) | False | False +Nullable> | [divisor](#divisor) | False | False +EnvString | [name](#name) | False | False +Enum(u'limits.cpu', u'limits.memory', u'requests.cpu', u'requests.memory') | [resource](#resource) | False | False ## PodVolumeSecretSpec - -``` -PodVolumeSecretSpec (abstract type): - parents: PodVolumeItemMapper, PodVolumeBaseSpec - parent types: PodTemplateSpec - properties: - defaultMode: Nullable> - item_map: Nullable> - name: Identifier - secret_name: Identifier - -``` +#### Parents: [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Properties: + +Name | Type | Identifier | Abstract +Nullable> | [defaultMode](#defaultmode) | False | False +Nullable> | [item_map](#item_map) | False | False +Identifier | [name](#name) | False | False +Identifier | [secret_name](#secret_name) | False | False From a5ef9ded11b92ee17ca09b9a78b5727e59399146 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 5 Jul 2018 10:08:28 +0200 Subject: [PATCH 06/40] Some addition to docs --- docs/rubiks.class.md | 958 ++++++++++++++++++++++++------------------- lib/kube_help.py | 59 ++- 2 files changed, 576 insertions(+), 441 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 7e582fc..95648ff 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -7,12 +7,13 @@ ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Map | [secrets](#secrets) | False | False -String | [tls_cert](#tls_cert) | False | False -String | [tls_key](#tls_key) | False | False -NonEmpty | [type](#type) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +secrets | Map | False | False | - +tls_cert | String | False | False | - +tls_key | String | False | False | - +type | NonEmpty | False | False | - ## Service #### Children: [ClusterIPService](#clusteripservice), [AWSLoadBalancerService](#awsloadbalancerservice) ``` @@ -22,11 +23,12 @@ NonEmpty | [type](#type) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -NonEmpty> | [ports](#ports) | False | True -NonEmpty> | [selector](#selector) | False | True -Nullable | [sessionAffinity](#sessionaffinity) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +ports | NonEmpty> | False | True | - +selector | NonEmpty> | False | True | - +sessionAffinity | Nullable | False | False | - ## DockerCredentials #### Parents: [Secret](#secret) ``` @@ -36,17 +38,19 @@ Nullable | [sessionAffinity](#sessionaffinity) | Fal ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Map> | [dockers](#dockers) | False | False -Map | [secrets](#secrets) | False | False -NonEmpty | [type](#type) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +dockers | Map> | False | False | - +secrets | Map | False | False | - +type | NonEmpty | False | False | - ## DplBaseUpdateStrategy #### Children: [DplRecreateStrategy](#dplrecreatestrategy), [DplRollingUpdateStrategy](#dplrollingupdatestrategy) #### Parent types: [Deployment](#deployment) #### Properties: -Name | Type | Identifier | Abstract +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- ## Role #### Parents: [RoleBase](#rolebase) ``` @@ -56,9 +60,10 @@ Name | Type | Identifier | Abstract ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -NonEmpty> | [rules](#rules) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +rules | NonEmpty> | False | False | - ## Group ``` metadata: @@ -67,29 +72,32 @@ NonEmpty> | [rules](#rules) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -NonEmpty> | [users](#users) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +users | NonEmpty> | False | False | - ## RouteTLS #### Parent types: [Route](#route) #### Properties: -Name | Type | Identifier | Abstract -Nullable> | [caCertificate](#cacertificate) | False | False -Nullable> | [certificate](#certificate) | False | False -Nullable> | [destinationCACertificate](#destinationcacertificate) | False | False -Enum(u'Allow', u'Disable', u'Redirect') | [insecureEdgeTerminationPolicy](#insecureedgeterminationpolicy) | False | False -Nullable> | [key](#key) | False | False -Enum(u'edge', u'reencrypt', u'passthrough') | [termination](#termination) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +caCertificate | Nullable> | False | False | - +certificate | Nullable> | False | False | - +destinationCACertificate | Nullable> | False | False | - +insecureEdgeTerminationPolicy | Enum(u'Allow', u'Disable', u'Redirect') | False | False | - +key | Nullable> | False | False | - +termination | Enum(u'edge', u'reencrypt', u'passthrough') | False | False | - ## SCCRunAsUser #### Parent types: [SecurityContextConstraints](#securitycontextconstraints) #### Properties: -Name | Type | Identifier | Abstract -Enum(u'MustRunAs', u'RunAsAny', u'MustRunAsRange', u'MustRunAsNonRoot') | [type](#type) | False | False -Nullable>> | [uid](#uid) | False | False -Nullable>> | [uidRangeMax](#uidrangemax) | False | False -Nullable>> | [uidRangeMin](#uidrangemin) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +type | Enum(u'MustRunAs', u'RunAsAny', u'MustRunAsRange', u'MustRunAsNonRoot') | False | False | - +uid | Nullable>> | False | False | - +uidRangeMax | Nullable>> | False | False | - +uidRangeMin | Nullable>> | False | False | - ## PersistentVolumeClaim ``` metadata: @@ -98,36 +106,40 @@ Nullable>> | [uidRangeMin](#uidrangemin) | False | Fal ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -List | [accessModes](#accessmodes) | False | False -Memory | [request](#request) | False | False -Nullable | [selector](#selector) | False | False -Nullable | [volumeName](#volumename) | False | True +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +accessModes | List | False | False | - +request | Memory | False | False | - +selector | Nullable | False | False | - +volumeName | Nullable | False | True | - ## PodVolumePVCSpec #### Parents: [PodVolumeBaseSpec](#podvolumebasespec) #### Parent types: [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [claimName](#claimname) | False | False -Identifier | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +claimName | Identifier | False | False | - +name | Identifier | False | False | - ## DCConfigChangeTrigger #### Parents: [DCTrigger](#dctrigger) #### Parent types: [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- ## SecurityContext #### Parent types: [ContainerSpec](#containerspec), [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [fsGroup](#fsgroup) | False | False -Nullable | [privileged](#privileged) | False | False -Nullable | [runAsNonRoot](#runasnonroot) | False | False -Nullable | [runAsUser](#runasuser) | False | False -Nullable> | [supplementalGroups](#supplementalgroups) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +fsGroup | Nullable | False | False | - +privileged | Nullable | False | False | - +runAsNonRoot | Nullable | False | False | - +runAsUser | Nullable | False | False | - +supplementalGroups | Nullable> | False | False | - ## Project #### Parents: [Namespace](#namespace) ``` @@ -137,8 +149,9 @@ Nullable> | [supplementalGroups](#supplementalgroups) | False | Fa ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - ## PersistentVolume ``` metadata: @@ -147,13 +160,14 @@ name | Identifier | True | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -List | [accessModes](#accessmodes) | False | False -Nullable | [awsElasticBlockStore](#awselasticblockstore) | False | False -Memory | [capacity](#capacity) | False | False -Nullable | [claimRef](#claimref) | False | False -Nullable | [persistentVolumeReclaimPolicy](#persistentvolumereclaimpolicy) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +accessModes | List | False | False | - +awsElasticBlockStore | Nullable | False | False | - +capacity | Memory | False | False | - +claimRef | Nullable | False | False | - +persistentVolumeReclaimPolicy | Nullable | False | False | - ## DeploymentConfig ``` metadata: @@ -162,58 +176,64 @@ Nullable | [persistentVolumeReclaimPolic ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Nullable>> | [minReadySeconds](#minreadyseconds) | False | False -Nullable | [paused](#paused) | False | False -PodTemplateSpec | [pod_template](#pod_template) | False | False -Positive> | [replicas](#replicas) | False | False -Nullable>> | [revisionHistoryLimit](#revisionhistorylimit) | False | False -Nullable> | [selector](#selector) | False | False -DCBaseUpdateStrategy | [strategy](#strategy) | False | False -Boolean | [test](#test) | False | False -List | [triggers](#triggers) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +minReadySeconds | Nullable>> | False | False | - +paused | Nullable | False | False | - +pod_template | PodTemplateSpec | False | False | - +replicas | Positive> | False | False | - +revisionHistoryLimit | Nullable>> | False | False | - +selector | Nullable> | False | False | - +strategy | DCBaseUpdateStrategy | False | False | - +test | Boolean | False | False | - +triggers | List | False | False | - ## ContainerPort #### Parent types: [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract -Positive> | [containerPort](#containerport) | False | False -Nullable | [hostIP](#hostip) | False | False -Nullable>> | [hostPort](#hostport) | False | False -Nullable | [name](#name) | False | False -Enum(u'TCP', u'UDP') | [protocol](#protocol) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +containerPort | Positive> | False | False | - +hostIP | Nullable | False | False | - +hostPort | Nullable>> | False | False | - +name | Nullable | False | False | - +protocol | Enum(u'TCP', u'UDP') | False | False | - ## DCImageChangeTrigger #### Parents: [DCTrigger](#dctrigger) #### Parent types: [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- ## RoleRef #### Parent types: [ClusterRoleBinding](#clusterrolebinding), [PolicyBindingRoleBinding](#policybindingrolebinding), [RoleBindingBase](#rolebindingbase), [RoleBinding](#rolebinding) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [name](#name) | False | False -Nullable | [ns](#ns) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Nullable | False | False | - +ns | Nullable | False | False | - ## LifeCycleHTTP #### Parents: [LifeCycleProbe](#lifecycleprobe) #### Parent types: [LifeCycle](#lifecycle) #### Properties: -Name | Type | Identifier | Abstract -NonEmpty | [path](#path) | False | False -Positive> | [port](#port) | False | False -Nullable | [scheme](#scheme) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +path | NonEmpty | False | False | - +port | Positive> | False | False | - +scheme | Nullable | False | False | - ## PodVolumeItemMapper #### Parents: [PodVolumeBaseSpec](#podvolumebasespec) #### Children: [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) #### Parent types: [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -Nullable> | [item_map](#item_map) | False | False -Identifier | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +item_map | Nullable> | False | False | - +name | Identifier | False | False | - ## DaemonSet #### Parents: [SelectorsPreProcessMixin](#selectorspreprocessmixin) ``` @@ -223,20 +243,22 @@ Identifier | [name](#name) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -PodTemplateSpec | [pod_template](#pod_template) | False | False -Nullable | [selector](#selector) | False | True +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +pod_template | PodTemplateSpec | False | False | - +selector | Nullable | False | True | - ## DCBaseUpdateStrategy #### Children: [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy), [DCCustomStrategy](#dccustomstrategy) #### Parent types: [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract -Nullable>> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False -Map | [annotations](#annotations) | False | False -Map | [labels](#labels) | False | False -Nullable | [resources](#resources) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +activeDeadlineSeconds | Nullable>> | False | False | - +annotations | Map | False | False | - +labels | Map | False | False | - +resources | Nullable | False | False | - ## Namespace #### Children: [Project](#project) ``` @@ -246,44 +268,49 @@ Nullable | [resources](#resources) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - ## ContainerEnvSpec #### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) #### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract -EnvString | [name](#name) | False | False -String | [value](#value) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | EnvString | False | False | - +value | String | False | False | - ## PodVolumeConfigMapSpec #### Parents: [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumeBaseSpec](#podvolumebasespec) #### Parent types: [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -Nullable> | [defaultMode](#defaultmode) | False | False -Nullable> | [item_map](#item_map) | False | False -Identifier | [map_name](#map_name) | False | False -Identifier | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +defaultMode | Nullable> | False | False | - +item_map | Nullable> | False | False | - +map_name | Identifier | False | False | - +name | Identifier | False | False | - ## MatchExpression #### Parent types: [MatchExpressionsSelector](#matchexpressionsselector) #### Properties: -Name | Type | Identifier | Abstract -NonEmpty | [key](#key) | False | False -Enum(u'In', u'NotIn', u'Exists', u'DoesNotExist') | [operator](#operator) | False | False -Nullable> | [values](#values) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +key | NonEmpty | False | False | - +operator | Enum(u'In', u'NotIn', u'Exists', u'DoesNotExist') | False | False | - +values | Nullable> | False | False | - ## SCCSELinux #### Parent types: [SecurityContextConstraints](#securitycontextconstraints) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [level](#level) | False | False -Nullable | [role](#role) | False | False -Nullable | [strategy](#strategy) | False | False -Nullable | [type](#type) | False | False -Nullable | [user](#user) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +level | Nullable | False | False | - +role | Nullable | False | False | - +strategy | Nullable | False | False | - +type | Nullable | False | False | - +user | Nullable | False | False | - ## ClusterRoleBinding #### Parents: [RoleBindingBase](#rolebindingbase), [RoleBindingXF](#rolebindingxf) ``` @@ -293,10 +320,11 @@ Nullable | [user](#user) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -RoleRef | [roleRef](#roleref) | False | True -NonEmpty> | [subjects](#subjects) | False | True +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +roleRef | RoleRef | False | True | - +subjects | NonEmpty> | False | True | - ## AWSLoadBalancerService #### Parents: [Service](#service) ``` @@ -306,14 +334,15 @@ NonEmpty> | [subjects](#subjects) | False | True ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Nullable | [aws-load-balancer-backend-protocol](#aws-load-balancer-backend-protocol) | False | False -Nullable | [aws-load-balancer-ssl-cert](#aws-load-balancer-ssl-cert) | False | False -Nullable | [externalTrafficPolicy](#externaltrafficpolicy) | False | False -NonEmpty> | [ports](#ports) | False | True -NonEmpty> | [selector](#selector) | False | True -Nullable | [sessionAffinity](#sessionaffinity) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +aws-load-balancer-backend-protocol | Nullable | False | False | - +aws-load-balancer-ssl-cert | Nullable | False | False | - +externalTrafficPolicy | Nullable | False | False | - +ports | NonEmpty> | False | True | - +selector | NonEmpty> | False | True | - +sessionAffinity | Nullable | False | False | - ## Job ``` metadata: @@ -322,109 +351,120 @@ Nullable | [sessionAffinity](#sessionaffinity) | Fal ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Nullable> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False -Nullable>> | [completions](#completions) | False | False -Nullable | [manualSelector](#manualselector) | False | False -Nullable>> | [parallelism](#parallelism) | False | False -PodTemplateSpec | [pod_template](#pod_template) | False | False -Nullable | [selector](#selector) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +activeDeadlineSeconds | Nullable> | False | False | - +completions | Nullable>> | False | False | - +manualSelector | Nullable | False | False | - +parallelism | Nullable>> | False | False | - +pod_template | PodTemplateSpec | False | False | - +selector | Nullable | False | False | - ## RouteDestService #### Parents: [RouteDest](#routedest) #### Parent types: [Route](#route) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [name](#name) | False | False -Positive> | [weight](#weight) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | False | False | - +weight | Positive> | False | False | - ## DCRecreateStrategy #### Parents: [DCBaseUpdateStrategy](#dcbaseupdatestrategy) #### Parent types: [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract -Nullable>> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False -Map | [annotations](#annotations) | False | False -Nullable | [customParams](#customparams) | False | False -Map | [labels](#labels) | False | False -Nullable | [recreateParams](#recreateparams) | False | False -Nullable | [resources](#resources) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +activeDeadlineSeconds | Nullable>> | False | False | - +annotations | Map | False | False | - +customParams | Nullable | False | False | - +labels | Map | False | False | - +recreateParams | Nullable | False | False | - +resources | Nullable | False | False | - ## DplRollingUpdateStrategy #### Parents: [DplBaseUpdateStrategy](#dplbaseupdatestrategy) #### Parent types: [Deployment](#deployment) #### Properties: -Name | Type | Identifier | Abstract -SurgeSpec | [maxSurge](#maxsurge) | False | False -SurgeSpec | [maxUnavailable](#maxunavailable) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +maxSurge | SurgeSpec | False | False | - +maxUnavailable | SurgeSpec | False | False | - ## ContainerSpec #### Parents: [EnvironmentPreProcessMixin](#environmentpreprocessmixin) #### Parent types: [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Nullable> | [args](#args) | False | False -Nullable> | [command](#command) | False | False -Nullable> | [env](#env) | False | True -NonEmpty | [image](#image) | False | False -Nullable | [imagePullPolicy](#imagepullpolicy) | False | False -Nullable | [kind](#kind) | False | False -Nullable | [lifecycle](#lifecycle) | False | False -Nullable | [livenessProbe](#livenessprobe) | False | False -Nullable> | [ports](#ports) | False | True -Nullable | [readinessProbe](#readinessprobe) | False | False -Nullable | [resources](#resources) | False | False -Nullable | [securityContext](#securitycontext) | False | False -Nullable> | [terminationMessagePath](#terminationmessagepath) | False | False -Nullable> | [volumeMounts](#volumemounts) | False | True +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +args | Nullable> | False | False | - +command | Nullable> | False | False | - +env | Nullable> | False | True | - +image | NonEmpty | False | False | - +imagePullPolicy | Nullable | False | False | - +kind | Nullable | False | False | - +lifecycle | Nullable | False | False | - +livenessProbe | Nullable | False | False | - +ports | Nullable> | False | True | - +readinessProbe | Nullable | False | False | - +resources | Nullable | False | False | - +securityContext | Nullable | False | False | - +terminationMessagePath | Nullable> | False | False | - +volumeMounts | Nullable> | False | True | - ## DplRecreateStrategy #### Parents: [DplBaseUpdateStrategy](#dplbaseupdatestrategy) #### Parent types: [Deployment](#deployment) #### Properties: -Name | Type | Identifier | Abstract +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- ## DCTrigger #### Children: [DCConfigChangeTrigger](#dcconfigchangetrigger), [DCImageChangeTrigger](#dcimagechangetrigger) #### Parent types: [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- ## ContainerEnvSecretSpec #### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) #### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract -NonEmpty | [key](#key) | False | False -EnvString | [name](#name) | False | False -Identifier | [secret_name](#secret_name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +key | NonEmpty | False | False | - +name | EnvString | False | False | - +secret_name | Identifier | False | False | - ## MatchExpressionsSelector #### Parents: [BaseSelector](#baseselector) #### Parent types: [DaemonSet](#daemonset), [Deployment](#deployment), [Job](#job), [PersistentVolumeClaim](#persistentvolumeclaim) #### Properties: -Name | Type | Identifier | Abstract -NonEmpty> | [matchExpressions](#matchexpressions) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +matchExpressions | NonEmpty> | False | False | - ## ContainerProbeBaseSpec #### Children: [ContainerProbeTCPPortSpec](#containerprobetcpportspec), [ContainerProbeHTTPSpec](#containerprobehttpspec) #### Parent types: [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract -Nullable>> | [failureThreshold](#failurethreshold) | False | False -Nullable> | [initialDelaySeconds](#initialdelayseconds) | False | False -Nullable>> | [periodSeconds](#periodseconds) | False | False -Nullable>> | [successThreshold](#successthreshold) | False | False -Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +failureThreshold | Nullable>> | False | False | - +initialDelaySeconds | Nullable> | False | False | - +periodSeconds | Nullable>> | False | False | - +successThreshold | Nullable>> | False | False | - +timeoutSeconds | Nullable>> | False | False | - ## PodVolumeEmptyDirSpec #### Parents: [PodVolumeBaseSpec](#podvolumebasespec) #### Parent types: [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | False | False | - ## PolicyBinding ``` metadata: @@ -433,9 +473,10 @@ Identifier | [name](#name) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | ColonIdentifier | True | False -List | [roleBindings](#rolebindings) | False | True +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | ColonIdentifier | True | False | - +roleBindings | List | False | True | - ## ConfigMap ``` metadata: @@ -444,34 +485,38 @@ List | [roleBindings](#rolebindings) | False | True ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Map | [files](#files) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +files | Map | False | False | - ## SCCGroups #### Parent types: [SecurityContextConstraints](#securitycontextconstraints) #### Properties: -Name | Type | Identifier | Abstract -Nullable> | [ranges](#ranges) | False | False -Nullable | [type](#type) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +ranges | Nullable> | False | False | - +type | Nullable | False | False | - ## DCCustomStrategy #### Parents: [DCBaseUpdateStrategy](#dcbaseupdatestrategy) #### Parent types: [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract -Nullable>> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False -Map | [annotations](#annotations) | False | False -DCCustomParams | [customParams](#customparams) | False | False -Map | [labels](#labels) | False | False -Nullable | [resources](#resources) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +activeDeadlineSeconds | Nullable>> | False | False | - +annotations | Map | False | False | - +customParams | DCCustomParams | False | False | - +labels | Map | False | False | - +resources | Nullable | False | False | - ## ContainerResourceEachSpec #### Parent types: [ContainerResourceSpec](#containerresourcespec) #### Properties: -Name | Type | Identifier | Abstract -Nullable>> | [cpu](#cpu) | False | True -Nullable | [memory](#memory) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +cpu | Nullable>> | False | True | - +memory | Nullable | False | False | - ## StorageClass ``` metadata: @@ -480,60 +525,67 @@ Nullable | [memory](#memory) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Map | [parameters](#parameters) | False | False -String | [provisioner](#provisioner) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +parameters | Map | False | False | - +provisioner | String | False | False | - ## DCRollingParams #### Parent types: [DCRollingStrategy](#dcrollingstrategy) #### Properties: -Name | Type | Identifier | Abstract -Nullable>> | [intervalSeconds](#intervalseconds) | False | False -SurgeSpec | [maxSurge](#maxsurge) | False | False -SurgeSpec | [maxUnavailable](#maxunavailable) | False | False -Nullable | [post](#post) | False | False -Nullable | [pre](#pre) | False | False -Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False -Nullable>> | [updatePeriodSeconds](#updateperiodseconds) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +intervalSeconds | Nullable>> | False | False | - +maxSurge | SurgeSpec | False | False | - +maxUnavailable | SurgeSpec | False | False | - +post | Nullable | False | False | - +pre | Nullable | False | False | - +timeoutSeconds | Nullable>> | False | False | - +updatePeriodSeconds | Nullable>> | False | False | - ## SCCGroupRange #### Parent types: [SCCGroups](#sccgroups) #### Properties: -Name | Type | Identifier | Abstract -Positive> | [max](#max) | False | False -Positive> | [min](#min) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +max | Positive> | False | False | - +min | Positive> | False | False | - ## DCCustomParams #### Parents: [EnvironmentPreProcessMixin](#environmentpreprocessmixin) #### Parent types: [DCCustomStrategy](#dccustomstrategy), [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy) #### Properties: -Name | Type | Identifier | Abstract -Nullable> | [command](#command) | False | False -Nullable> | [environment](#environment) | False | True -NonEmpty | [image](#image) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +command | Nullable> | False | False | - +environment | Nullable> | False | True | - +image | NonEmpty | False | False | - ## ContainerVolumeMountSpec #### Parent types: [ContainerSpec](#containerspec), [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [name](#name) | False | False -NonEmpty | [path](#path) | False | False -Nullable | [readOnly](#readonly) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | False | False | - +path | NonEmpty | False | False | - +readOnly | Nullable | False | False | - ## LifeCycleProbe #### Children: [LifeCycleExec](#lifecycleexec), [LifeCycleHTTP](#lifecyclehttp) #### Parent types: [LifeCycle](#lifecycle) #### Properties: -Name | Type | Identifier | Abstract +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- ## SASecretSubject #### Parent types: [ServiceAccount](#serviceaccount) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [kind](#kind) | False | False -Nullable | [name](#name) | False | False -Nullable | [ns](#ns) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +kind | Nullable | False | False | - +name | Nullable | False | False | - +ns | Nullable | False | False | - ## PodTemplateSpec #### Parent types: [DaemonSet](#daemonset), [DeploymentConfig](#deploymentconfig), [Deployment](#deployment), [Job](#job), [ReplicationController](#replicationcontroller) ``` @@ -543,20 +595,21 @@ Nullable | [ns](#ns) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -NonEmpty> | [containers](#containers) | False | False -Nullable | [dnsPolicy](#dnspolicy) | False | False -Nullable | [hostIPC](#hostipc) | False | False -Nullable | [hostNetwork](#hostnetwork) | False | False -Nullable | [hostPID](#hostpid) | False | False -Nullable> | [imagePullSecrets](#imagepullsecrets) | False | True -Nullable | [name](#name) | False | False -Nullable> | [nodeSelector](#nodeselector) | False | False -Nullable | [restartPolicy](#restartpolicy) | False | False -Nullable | [securityContext](#securitycontext) | False | False -Nullable | [serviceAccountName](#serviceaccountname) | False | True -Nullable> | [terminationGracePeriodSeconds](#terminationgraceperiodseconds) | False | False -Nullable> | [volumes](#volumes) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +containers | NonEmpty> | False | False | - +dnsPolicy | Nullable | False | False | - +hostIPC | Nullable | False | False | - +hostNetwork | Nullable | False | False | - +hostPID | Nullable | False | False | - +imagePullSecrets | Nullable> | False | True | - +name | Nullable | False | False | - +nodeSelector | Nullable> | False | False | - +restartPolicy | Nullable | False | False | - +securityContext | Nullable | False | False | - +serviceAccountName | Nullable | False | True | [serviceAccount](#serviceaccount) +terminationGracePeriodSeconds | Nullable> | False | False | - +volumes | Nullable> | False | False | - ## User ``` metadata: @@ -565,54 +618,60 @@ Nullable> | [volumes](#volumes) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | UserIdentifier | True | False -Nullable | [fullName](#fullname) | False | False -NonEmpty>> | [identities](#identities) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | UserIdentifier | True | False | - +fullName | Nullable | False | False | - +identities | NonEmpty>> | False | False | - ## ContainerEnvConfigMapSpec #### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) #### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract -NonEmpty | [key](#key) | False | False -Identifier | [map_name](#map_name) | False | False -EnvString | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +key | NonEmpty | False | False | - +map_name | Identifier | False | False | - +name | EnvString | False | False | - ## LifeCycleExec #### Parents: [LifeCycleProbe](#lifecycleprobe) #### Parent types: [LifeCycle](#lifecycle) #### Properties: -Name | Type | Identifier | Abstract -NonEmpty> | [command](#command) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +command | NonEmpty> | False | False | - ## DCRollingStrategy #### Parents: [DCBaseUpdateStrategy](#dcbaseupdatestrategy) #### Parent types: [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract -Nullable>> | [activeDeadlineSeconds](#activedeadlineseconds) | False | False -Map | [annotations](#annotations) | False | False -Nullable | [customParams](#customparams) | False | False -Map | [labels](#labels) | False | False -Nullable | [resources](#resources) | False | False -Nullable | [rollingParams](#rollingparams) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +activeDeadlineSeconds | Nullable>> | False | False | - +annotations | Map | False | False | - +customParams | Nullable | False | False | - +labels | Map | False | False | - +resources | Nullable | False | False | - +rollingParams | Nullable | False | False | - ## RouteDest #### Children: [RouteDestService](#routedestservice) #### Parent types: [Route](#route) #### Properties: -Name | Type | Identifier | Abstract -Positive> | [weight](#weight) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +weight | Positive> | False | False | - ## ContainerEnvPodFieldSpec #### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) #### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [apiVersion](#apiversion) | False | False -Enum(u'metadata.name', u'metadata.namespace', u'metadata.labels', u'metadata.annotations', u'spec.nodeName', u'spec.serviceAccountName', u'status.podIP') | [fieldPath](#fieldpath) | False | False -EnvString | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +apiVersion | Nullable | False | False | - +fieldPath | Enum(u'metadata.name', u'metadata.namespace', u'metadata.labels', u'metadata.annotations', u'spec.nodeName', u'spec.serviceAccountName', u'status.podIP') | False | False | - +name | EnvString | False | False | - ## ServiceAccount ``` metadata: @@ -621,17 +680,19 @@ EnvString | [name](#name) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Nullable> | [imagePullSecrets](#imagepullsecrets) | False | True -Nullable> | [secrets](#secrets) | False | True +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +imagePullSecrets | Nullable> | False | True | - +secrets | Nullable> | False | True | - ## PodVolumeBaseSpec #### Children: [PodVolumeHostSpec](#podvolumehostspec), [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumePVCSpec](#podvolumepvcspec), [PodVolumeEmptyDirSpec](#podvolumeemptydirspec), [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) #### Parent types: [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | False | False | - ## ClusterRole #### Parents: [RoleBase](#rolebase) ``` @@ -641,17 +702,19 @@ Identifier | [name](#name) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -NonEmpty> | [rules](#rules) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +rules | NonEmpty> | False | False | - ## DCLifecycleHook #### Parent types: [DCRecreateParams](#dcrecreateparams), [DCRollingParams](#dcrollingparams) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [execNewPod](#execnewpod) | False | False -Enum(u'Abort', u'Retry', u'Ignore') | [failurePolicy](#failurepolicy) | False | False -Nullable | [tagImages](#tagimages) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +execNewPod | Nullable | False | False | - +failurePolicy | Enum(u'Abort', u'Retry', u'Ignore') | False | False | - +tagImages | Nullable | False | False | - ## ClusterIPService #### Parents: [Service](#service) ``` @@ -661,81 +724,89 @@ Nullable | [tagImages](#tagimages) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Nullable | [clusterIP](#clusterip) | False | False -NonEmpty> | [ports](#ports) | False | True -NonEmpty> | [selector](#selector) | False | True -Nullable | [sessionAffinity](#sessionaffinity) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +clusterIP | Nullable | False | False | - +ports | NonEmpty> | False | True | - +selector | NonEmpty> | False | True | - +sessionAffinity | Nullable | False | False | - ## PersistentVolumeRef #### Parent types: [PersistentVolume](#persistentvolume) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [apiVersion](#apiversion) | False | False -Nullable | [kind](#kind) | False | False -Nullable | [name](#name) | False | False -Nullable | [ns](#ns) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +apiVersion | Nullable | False | False | - +kind | Nullable | False | False | - +name | Nullable | False | False | - +ns | Nullable | False | False | - ## DCLifecycleNewPod #### Parents: [EnvironmentPreProcessMixin](#environmentpreprocessmixin) #### Parent types: [DCLifecycleHook](#dclifecyclehook) #### Properties: -Name | Type | Identifier | Abstract -NonEmpty> | [command](#command) | False | False -Identifier | [containerName](#containername) | False | False -Nullable> | [env](#env) | False | True -Nullable> | [volumeMounts](#volumemounts) | False | False -Nullable> | [volumes](#volumes) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +command | NonEmpty> | False | False | - +containerName | Identifier | False | False | - +env | Nullable> | False | True | - +volumeMounts | Nullable> | False | False | - +volumes | Nullable> | False | False | - ## ContainerProbeTCPPortSpec #### Parents: [ContainerProbeBaseSpec](#containerprobebasespec) #### Parent types: [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract -Nullable>> | [failureThreshold](#failurethreshold) | False | False -Nullable> | [initialDelaySeconds](#initialdelayseconds) | False | False -Nullable>> | [periodSeconds](#periodseconds) | False | False -Positive> | [port](#port) | False | True -Nullable>> | [successThreshold](#successthreshold) | False | False -Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +failureThreshold | Nullable>> | False | False | - +initialDelaySeconds | Nullable> | False | False | - +periodSeconds | Nullable>> | False | False | - +port | Positive> | False | True | - +successThreshold | Nullable>> | False | False | - +timeoutSeconds | Nullable>> | False | False | - ## ContainerEnvBaseSpec #### Children: [ContainerEnvSpec](#containerenvspec), [ContainerEnvConfigMapSpec](#containerenvconfigmapspec), [ContainerEnvSecretSpec](#containerenvsecretspec), [ContainerEnvPodFieldSpec](#containerenvpodfieldspec), [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) #### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract -EnvString | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | EnvString | False | False | - ## PodVolumeHostSpec #### Parents: [PodVolumeBaseSpec](#podvolumebasespec) #### Parent types: [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [name](#name) | False | False -String | [path](#path) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | False | False | - +path | String | False | False | - ## DCRecreateParams #### Parent types: [DCRecreateStrategy](#dcrecreatestrategy) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [mid](#mid) | False | False -Nullable | [post](#post) | False | False -Nullable | [pre](#pre) | False | False -Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +mid | Nullable | False | False | - +post | Nullable | False | False | - +pre | Nullable | False | False | - +timeoutSeconds | Nullable>> | False | False | - ## DCTagImages #### Parent types: [DCLifecycleHook](#dclifecyclehook) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [containerName](#containername) | False | False -Nullable | [toApiVersion](#toapiversion) | False | False -Nullable | [toFieldPath](#tofieldpath) | False | False -Nullable | [toKind](#tokind) | False | False -Nullable | [toName](#toname) | False | False -Nullable | [toNamespace](#tonamespace) | False | False -Nullable | [toResourceVersion](#toresourceversion) | False | False -Nullable | [toUid](#touid) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +containerName | Identifier | False | False | - +toApiVersion | Nullable | False | False | - +toFieldPath | Nullable | False | False | - +toKind | Nullable | False | False | - +toName | Nullable | False | False | - +toNamespace | Nullable | False | False | - +toResourceVersion | Nullable | False | False | - +toUid | Nullable | False | False | - ## Secret #### Children: [DockerCredentials](#dockercredentials), [TLSCredentials](#tlscredentials) ``` @@ -745,53 +816,59 @@ Nullable | [toUid](#touid) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Map | [secrets](#secrets) | False | False -NonEmpty | [type](#type) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +secrets | Map | False | False | - +type | NonEmpty | False | False | - ## RouteDestPort #### Parent types: [Route](#route) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [targetPort](#targetport) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +targetPort | Identifier | False | False | - ## BaseSelector #### Children: [MatchLabelsSelector](#matchlabelsselector), [MatchExpressionsSelector](#matchexpressionsselector) #### Parent types: [DaemonSet](#daemonset), [Deployment](#deployment), [Job](#job), [PersistentVolumeClaim](#persistentvolumeclaim) #### Properties: -Name | Type | Identifier | Abstract +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- ## ContainerProbeHTTPSpec #### Parents: [ContainerProbeBaseSpec](#containerprobebasespec) #### Parent types: [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract -Nullable>> | [failureThreshold](#failurethreshold) | False | False -Nullable | [host](#host) | False | False -Nullable> | [initialDelaySeconds](#initialdelayseconds) | False | False -NonEmpty | [path](#path) | False | False -Nullable>> | [periodSeconds](#periodseconds) | False | False -Positive> | [port](#port) | False | True -Nullable | [scheme](#scheme) | False | False -Nullable>> | [successThreshold](#successthreshold) | False | False -Nullable>> | [timeoutSeconds](#timeoutseconds) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +failureThreshold | Nullable>> | False | False | - +host | Nullable | False | False | - +initialDelaySeconds | Nullable> | False | False | - +path | NonEmpty | False | False | - +periodSeconds | Nullable>> | False | False | - +port | Positive> | False | True | - +scheme | Nullable | False | False | - +successThreshold | Nullable>> | False | False | - +timeoutSeconds | Nullable>> | False | False | - ## ServicePort #### Parent types: [AWSLoadBalancerService](#awsloadbalancerservice), [ClusterIPService](#clusteripservice), [Service](#service) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [name](#name) | False | False -Positive> | [port](#port) | False | False -Enum(u'TCP', u'UDP') | [protocol](#protocol) | False | False -OneOf>, Identifier> | [targetPort](#targetport) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Nullable | False | False | - +port | Positive> | False | False | - +protocol | Enum(u'TCP', u'UDP') | False | False | - +targetPort | OneOf>, Identifier> | False | False | - ## AWSElasticBlockStore #### Parent types: [PersistentVolume](#persistentvolume) #### Properties: -Name | Type | Identifier | Abstract -Enum(u'ext4') | [fsType](#fstype) | False | False -AWSVolID | [volumeID](#volumeid) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +fsType | Enum(u'ext4') | False | False | - +volumeID | AWSVolID | False | False | - ## ReplicationController ``` metadata: @@ -800,18 +877,20 @@ AWSVolID | [volumeID](#volumeid) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Nullable>> | [minReadySeconds](#minreadyseconds) | False | False -PodTemplateSpec | [pod_template](#pod_template) | False | False -Positive> | [replicas](#replicas) | False | False -Nullable> | [selector](#selector) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +minReadySeconds | Nullable>> | False | False | - +pod_template | PodTemplateSpec | False | False | - +replicas | Positive> | False | False | - +selector | Nullable> | False | False | - ## SAImgPullSecretSubject #### Parent types: [ServiceAccount](#serviceaccount) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | False | False | - ## Deployment ``` metadata: @@ -820,30 +899,33 @@ Identifier | [name](#name) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Nullable>> | [minReadySeconds](#minreadyseconds) | False | False -Nullable | [paused](#paused) | False | False -PodTemplateSpec | [pod_template](#pod_template) | False | False -Nullable>> | [progressDeadlineSeconds](#progressdeadlineseconds) | False | False -Positive> | [replicas](#replicas) | False | False -Nullable>> | [revisionHistoryLimit](#revisionhistorylimit) | False | False -Nullable | [selector](#selector) | False | False -Nullable | [strategy](#strategy) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +minReadySeconds | Nullable>> | False | False | - +paused | Nullable | False | False | - +pod_template | PodTemplateSpec | False | False | - +progressDeadlineSeconds | Nullable>> | False | False | - +replicas | Positive> | False | False | - +revisionHistoryLimit | Nullable>> | False | False | - +selector | Nullable | False | False | - +strategy | Nullable | False | False | - ## PodImagePullSecret #### Parent types: [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -Identifier | [name](#name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | False | False | - ## RoleSubject #### Parent types: [ClusterRoleBinding](#clusterrolebinding), [PolicyBindingRoleBinding](#policybindingrolebinding), [RoleBindingBase](#rolebindingbase), [RoleBinding](#rolebinding) #### Properties: -Name | Type | Identifier | Abstract -CaseIdentifier | [kind](#kind) | False | False -String | [name](#name) | False | False -Nullable | [ns](#ns) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +kind | CaseIdentifier | False | False | - +name | String | False | False | - +ns | Nullable | False | False | - ## SecurityContextConstraints ``` metadata: @@ -852,27 +934,28 @@ Nullable | [ns](#ns) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | Identifier | True | False -Boolean | [allowHostDirVolumePlugin](#allowhostdirvolumeplugin) | False | False -Boolean | [allowHostIPC](#allowhostipc) | False | False -Boolean | [allowHostNetwork](#allowhostnetwork) | False | False -Boolean | [allowHostPID](#allowhostpid) | False | False -Boolean | [allowHostPorts](#allowhostports) | False | False -Boolean | [allowPrivilegedContainer](#allowprivilegedcontainer) | False | False -Nullable> | [allowedCapabilities](#allowedcapabilities) | False | False -Nullable> | [defaultAddCapabilities](#defaultaddcapabilities) | False | False -Nullable | [fsGroup](#fsgroup) | False | False -List | [groups](#groups) | False | False -Nullable> | [priority](#priority) | False | False -Boolean | [readOnlyRootFilesystem](#readonlyrootfilesystem) | False | False -Nullable> | [requiredDropCapabilities](#requireddropcapabilities) | False | False -Nullable | [runAsUser](#runasuser) | False | False -Nullable | [seLinuxContext](#selinuxcontext) | False | False -Nullable> | [seccompProfiles](#seccompprofiles) | False | False -Nullable | [supplementalGroups](#supplementalgroups) | False | False -List | [users](#users) | False | False -List | [volumes](#volumes) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +allowHostDirVolumePlugin | Boolean | False | False | - +allowHostIPC | Boolean | False | False | - +allowHostNetwork | Boolean | False | False | - +allowHostPID | Boolean | False | False | - +allowHostPorts | Boolean | False | False | - +allowPrivilegedContainer | Boolean | False | False | - +allowedCapabilities | Nullable> | False | False | - +defaultAddCapabilities | Nullable> | False | False | - +fsGroup | Nullable | False | False | - +groups | List | False | False | - +priority | Nullable> | False | False | - +readOnlyRootFilesystem | Boolean | False | False | - +requiredDropCapabilities | Nullable> | False | False | - +runAsUser | Nullable | False | False | - +seLinuxContext | Nullable | False | False | - +seccompProfiles | Nullable> | False | False | - +supplementalGroups | Nullable | False | False | - +users | List | False | False | - +volumes | List | False | False | - ## Route ``` metadata: @@ -881,38 +964,42 @@ List | [tls](#tls) | False | False -NonEmpty> | [to](#to) | False | False -Enum(u'Subdomain', u'None') | [wildcardPolicy](#wildcardpolicy) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | Identifier | True | False | - +host | Domain | False | False | - +port | RouteDestPort | False | False | - +tls | Nullable | False | False | - +to | NonEmpty> | False | False | - +wildcardPolicy | Enum(u'Subdomain', u'None') | False | False | - ## ContainerResourceSpec #### Parent types: [ContainerSpec](#containerspec), [DCBaseUpdateStrategy](#dcbaseupdatestrategy), [DCCustomStrategy](#dccustomstrategy), [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy) #### Properties: -Name | Type | Identifier | Abstract -ContainerResourceEachSpec | [limits](#limits) | False | False -ContainerResourceEachSpec | [requests](#requests) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +limits | ContainerResourceEachSpec | False | False | - +requests | ContainerResourceEachSpec | False | False | - ## PolicyBindingRoleBinding #### Parents: [RoleBindingXF](#rolebindingxf) #### Parent types: [PolicyBinding](#policybinding) #### Properties: -Name | Type | Identifier | Abstract -Nullable> | [metadata](#metadata) | False | False -SystemIdentifier | [name](#name) | False | False -Identifier | [ns](#ns) | False | False -RoleRef | [roleRef](#roleref) | False | True -NonEmpty> | [subjects](#subjects) | False | True +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +metadata | Nullable> | False | False | - +name | SystemIdentifier | False | False | - +ns | Identifier | False | False | - +roleRef | RoleRef | False | True | - +subjects | NonEmpty> | False | True | - ## LifeCycle #### Parent types: [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [postStart](#poststart) | False | False -Nullable | [preStop](#prestop) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +postStart | Nullable | False | False | - +preStop | Nullable | False | False | - ## RoleBinding #### Parents: [RoleBindingBase](#rolebindingbase), [RoleBindingXF](#rolebindingxf) ``` @@ -922,45 +1009,50 @@ Nullable | [preStop](#prestop) | False | False ``` #### Properties: -Name | Type | Identifier | Abstract -name | SystemIdentifier | True | False -RoleRef | [roleRef](#roleref) | False | True -NonEmpty> | [subjects](#subjects) | False | True +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +name | SystemIdentifier | True | False | - +roleRef | RoleRef | False | True | - +subjects | NonEmpty> | False | True | - ## MatchLabelsSelector #### Parents: [BaseSelector](#baseselector) #### Parent types: [DaemonSet](#daemonset), [Deployment](#deployment), [Job](#job), [PersistentVolumeClaim](#persistentvolumeclaim) #### Properties: -Name | Type | Identifier | Abstract -Map | [matchLabels](#matchlabels) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +matchLabels | Map | False | False | - ## PolicyRule #### Parent types: [ClusterRole](#clusterrole), [RoleBase](#rolebase), [Role](#role) #### Properties: -Name | Type | Identifier | Abstract -NonEmpty> | [apiGroups](#apigroups) | False | False -Nullable | [attributeRestrictions](#attributerestrictions) | False | False -Nullable> | [nonResourceURLs](#nonresourceurls) | False | False -Nullable> | [resourceNames](#resourcenames) | False | False -NonEmpty>> | [resources](#resources) | False | False -NonEmpty> | [verbs](#verbs) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +apiGroups | NonEmpty> | False | False | - +attributeRestrictions | Nullable | False | False | - +nonResourceURLs | Nullable> | False | False | - +resourceNames | Nullable> | False | False | - +resources | NonEmpty>> | False | False | - +verbs | NonEmpty> | False | False | - ## ContainerEnvContainerResourceSpec #### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) #### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract -Nullable | [containerName](#containername) | False | False -Nullable> | [divisor](#divisor) | False | False -EnvString | [name](#name) | False | False -Enum(u'limits.cpu', u'limits.memory', u'requests.cpu', u'requests.memory') | [resource](#resource) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +containerName | Nullable | False | False | - +divisor | Nullable> | False | False | - +name | EnvString | False | False | - +resource | Enum(u'limits.cpu', u'limits.memory', u'requests.cpu', u'requests.memory') | False | False | - ## PodVolumeSecretSpec #### Parents: [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumeBaseSpec](#podvolumebasespec) #### Parent types: [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract -Nullable> | [defaultMode](#defaultmode) | False | False -Nullable> | [item_map](#item_map) | False | False -Identifier | [name](#name) | False | False -Identifier | [secret_name](#secret_name) | False | False +Name | Type | Identifier | Abstract | Mapping +---- | ---- | ---------- | -------- | ------- +defaultMode | Nullable> | False | False | - +item_map | Nullable> | False | False | - +name | Identifier | False | False | - +secret_name | Identifier | False | False | - diff --git a/lib/kube_help.py b/lib/kube_help.py index 7f0b6db..a65baa7 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -11,7 +11,7 @@ # Object used to collect class definition and implement the rendering functions class KubeHelper(object): _class_name = None - _class_subclasses = None + _class_subclasses = [] _class_superclasses = None _class_types = {} _class_is_abstract = None @@ -65,15 +65,58 @@ def render_terminal(self): return txt + + def _get_markdown_link(self, objects): + return ['[{}](#{})'.format(classname, classname.lower()) for classname in objects] + def render_markdown(self): - description = '```\n{}\n```'.format(self.render_terminal()) - - title = '## {}\n'.format(self._class_name) + # Title generation based on link if self._class_doc_link is not None: - title = '## [{}]({})\n'.format(self._class_name, self._class_doc_link) + txt = '## [{}]({})\n'.format(self._class_name, self._class_doc_link) + else: + txt = '## {}\n'.format(self._class_name) + # Add class doc string if exists if self._class_doc is not None: - return '{}\n{}\n\n{}\n'.format(title, self._class_doc, description) - else: - return '{}\n{}\n'.format(title, description) + txt += '\n{}\n---\n'.format(self._class_doc) + + # Parents + if len(self._class_superclasses) != 0: + txt += '#### Parents: {}\n'.format(', '.join(self._get_markdown_link(self._class_superclasses))) + + # Children + if len(self._class_subclasses) != 0: + txt += '#### Children: {}\n'.format(', '.join(self._get_markdown_link(self._class_subclasses))) + + # Parent types + if len(self._class_parent_types) != 0: + txt += '#### Parent types: {}\n'.format(', '.join(sorted(self._get_markdown_link(self._class_parent_types.keys())))) + + # Metadata + if self._class_has_metadata: + txt += '```\n' + txt += ' metadata:\n' + txt += ' annotations: {}\n'.format(Map(String, String).name()) + txt += ' labels: {}\n'.format(Map(String, String).name()) + txt += '```\n' + + # Properties table + txt += '#### Properties:\n\n' + txt += 'Name | Type | Identifier | Abstract | Mapping\n' + txt += '---- | ---- | ---------- | -------- | -------\n' + if self._class_identifier is not None: + txt += '{} | {} | True | False | - \n'.format(self._class_identifier, self._class_types[self._class_identifier].name()) + + for p in sorted(self._class_types.keys()): + if p == self._class_identifier: + continue + + is_abstract = True if 'xf_{}'.format(p) in self._class_xf_hasattr else False + is_mapped = ', '.join(self._get_markdown_link(self._class_mapping[p])) if p in self._class_mapping else '-' + + print(self._class_types[p]) + + txt += '{} | {} | False | {} | {} \n'.format(p, self._class_types[p].name(), is_abstract, is_mapped) + + return txt \ No newline at end of file From 73be050fce441f12583744004b60dba25d8178c3 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 5 Jul 2018 10:14:08 +0200 Subject: [PATCH 07/40] Styling --- docs/rubiks.class.md | 474 ++++++++++++++++++++++++++++++------------- 1 file changed, 329 insertions(+), 145 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 95648ff..602c02a 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -1,7 +1,8 @@ ## TLSCredentials -#### Parents: [Secret](#secret) +#### Parents: +- [Secret](#secret) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -15,9 +16,11 @@ tls_cert | String | False | False | - tls_key | String | False | False | - type | NonEmpty | False | False | - ## Service -#### Children: [ClusterIPService](#clusteripservice), [AWSLoadBalancerService](#awsloadbalancerservice) +#### Children: +- [ClusterIPService](#clusteripservice) +- [AWSLoadBalancerService](#awsloadbalancerservice) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -30,9 +33,10 @@ ports | NonEmpty> | False | True | - selector | NonEmpty> | False | True | - sessionAffinity | Nullable | False | False | - ## DockerCredentials -#### Parents: [Secret](#secret) +#### Parents: +- [Secret](#secret) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -45,16 +49,20 @@ dockers | Map> | False | False | - secrets | Map | False | False | - type | NonEmpty | False | False | - ## DplBaseUpdateStrategy -#### Children: [DplRecreateStrategy](#dplrecreatestrategy), [DplRollingUpdateStrategy](#dplrollingupdatestrategy) -#### Parent types: [Deployment](#deployment) +#### Children: +- [DplRecreateStrategy](#dplrecreatestrategy) +- [DplRollingUpdateStrategy](#dplrollingupdatestrategy) +#### Parent types: +- [Deployment](#deployment) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- ## Role -#### Parents: [RoleBase](#rolebase) +#### Parents: +- [RoleBase](#rolebase) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -65,8 +73,8 @@ Name | Type | Identifier | Abstract | Mapping name | Identifier | True | False | - rules | NonEmpty> | False | False | - ## Group +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -77,7 +85,8 @@ Name | Type | Identifier | Abstract | Mapping name | Identifier | True | False | - users | NonEmpty> | False | False | - ## RouteTLS -#### Parent types: [Route](#route) +#### Parent types: +- [Route](#route) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -89,7 +98,8 @@ insecureEdgeTerminationPolicy | Enum(u'Allow', u'Disable', u'Redirect') | False key | Nullable> | False | False | - termination | Enum(u'edge', u'reencrypt', u'passthrough') | False | False | - ## SCCRunAsUser -#### Parent types: [SecurityContextConstraints](#securitycontextconstraints) +#### Parent types: +- [SecurityContextConstraints](#securitycontextconstraints) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -99,8 +109,8 @@ uid | Nullable>> | False | False | - uidRangeMax | Nullable>> | False | False | - uidRangeMin | Nullable>> | False | False | - ## PersistentVolumeClaim +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -114,8 +124,10 @@ request | Memory | False | False | - selector | Nullable | False | False | - volumeName | Nullable | False | True | - ## PodVolumePVCSpec -#### Parents: [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Parents: +- [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -123,14 +135,18 @@ Name | Type | Identifier | Abstract | Mapping claimName | Identifier | False | False | - name | Identifier | False | False | - ## DCConfigChangeTrigger -#### Parents: [DCTrigger](#dctrigger) -#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Parents: +- [DCTrigger](#dctrigger) +#### Parent types: +- [DeploymentConfig](#deploymentconfig) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- ## SecurityContext -#### Parent types: [ContainerSpec](#containerspec), [PodTemplateSpec](#podtemplatespec) +#### Parent types: +- [ContainerSpec](#containerspec) +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -141,9 +157,10 @@ runAsNonRoot | Nullable | False | False | - runAsUser | Nullable | False | False | - supplementalGroups | Nullable> | False | False | - ## Project -#### Parents: [Namespace](#namespace) +#### Parents: +- [Namespace](#namespace) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -153,8 +170,8 @@ Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- name | Identifier | True | False | - ## PersistentVolume +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -169,8 +186,8 @@ capacity | Memory | False | False | - claimRef | Nullable | False | False | - persistentVolumeReclaimPolicy | Nullable | False | False | - ## DeploymentConfig +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -189,7 +206,8 @@ strategy | DCBaseUpdateStrategy | False | False | - test | Boolean | False | False | - triggers | List | False | False | - ## ContainerPort -#### Parent types: [ContainerSpec](#containerspec) +#### Parent types: +- [ContainerSpec](#containerspec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -200,14 +218,20 @@ hostPort | Nullable>> | False | False | - name | Nullable | False | False | - protocol | Enum(u'TCP', u'UDP') | False | False | - ## DCImageChangeTrigger -#### Parents: [DCTrigger](#dctrigger) -#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Parents: +- [DCTrigger](#dctrigger) +#### Parent types: +- [DeploymentConfig](#deploymentconfig) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- ## RoleRef -#### Parent types: [ClusterRoleBinding](#clusterrolebinding), [PolicyBindingRoleBinding](#policybindingrolebinding), [RoleBindingBase](#rolebindingbase), [RoleBinding](#rolebinding) +#### Parent types: +- [ClusterRoleBinding](#clusterrolebinding) +- [PolicyBindingRoleBinding](#policybindingrolebinding) +- [RoleBinding](#rolebinding) +- [RoleBindingBase](#rolebindingbase) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -215,8 +239,10 @@ Name | Type | Identifier | Abstract | Mapping name | Nullable | False | False | - ns | Nullable | False | False | - ## LifeCycleHTTP -#### Parents: [LifeCycleProbe](#lifecycleprobe) -#### Parent types: [LifeCycle](#lifecycle) +#### Parents: +- [LifeCycleProbe](#lifecycleprobe) +#### Parent types: +- [LifeCycle](#lifecycle) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -225,9 +251,13 @@ path | NonEmpty | False | False | - port | Positive> | False | False | - scheme | Nullable | False | False | - ## PodVolumeItemMapper -#### Parents: [PodVolumeBaseSpec](#podvolumebasespec) -#### Children: [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) -#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Parents: +- [PodVolumeBaseSpec](#podvolumebasespec) +#### Children: +- [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) +- [PodVolumeSecretSpec](#podvolumesecretspec) +#### Parent types: +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -235,9 +265,10 @@ Name | Type | Identifier | Abstract | Mapping item_map | Nullable> | False | False | - name | Identifier | False | False | - ## DaemonSet -#### Parents: [SelectorsPreProcessMixin](#selectorspreprocessmixin) +#### Parents: +- [SelectorsPreProcessMixin](#selectorspreprocessmixin) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -249,8 +280,12 @@ name | Identifier | True | False | - pod_template | PodTemplateSpec | False | False | - selector | Nullable | False | True | - ## DCBaseUpdateStrategy -#### Children: [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy), [DCCustomStrategy](#dccustomstrategy) -#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Children: +- [DCRecreateStrategy](#dcrecreatestrategy) +- [DCRollingStrategy](#dcrollingstrategy) +- [DCCustomStrategy](#dccustomstrategy) +#### Parent types: +- [DeploymentConfig](#deploymentconfig) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -260,9 +295,10 @@ annotations | Map | False | False | - labels | Map | False | False | - resources | Nullable | False | False | - ## Namespace -#### Children: [Project](#project) +#### Children: +- [Project](#project) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -272,8 +308,12 @@ Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- name | Identifier | True | False | - ## ContainerEnvSpec -#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Parents: +- [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -281,8 +321,11 @@ Name | Type | Identifier | Abstract | Mapping name | EnvString | False | False | - value | String | False | False | - ## PodVolumeConfigMapSpec -#### Parents: [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Parents: +- [PodVolumeItemMapper](#podvolumeitemmapper) +- [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -292,7 +335,8 @@ item_map | Nullable> | False | False | - map_name | Identifier | False | False | - name | Identifier | False | False | - ## MatchExpression -#### Parent types: [MatchExpressionsSelector](#matchexpressionsselector) +#### Parent types: +- [MatchExpressionsSelector](#matchexpressionsselector) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -301,7 +345,8 @@ key | NonEmpty | False | False | - operator | Enum(u'In', u'NotIn', u'Exists', u'DoesNotExist') | False | False | - values | Nullable> | False | False | - ## SCCSELinux -#### Parent types: [SecurityContextConstraints](#securitycontextconstraints) +#### Parent types: +- [SecurityContextConstraints](#securitycontextconstraints) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -312,9 +357,11 @@ strategy | Nullable | False | False | - type | Nullable | False | False | - user | Nullable | False | False | - ## ClusterRoleBinding -#### Parents: [RoleBindingBase](#rolebindingbase), [RoleBindingXF](#rolebindingxf) +#### Parents: +- [RoleBindingBase](#rolebindingbase) +- [RoleBindingXF](#rolebindingxf) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -326,9 +373,10 @@ name | Identifier | True | False | - roleRef | RoleRef | False | True | - subjects | NonEmpty> | False | True | - ## AWSLoadBalancerService -#### Parents: [Service](#service) +#### Parents: +- [Service](#service) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -344,8 +392,8 @@ ports | NonEmpty> | False | True | - selector | NonEmpty> | False | True | - sessionAffinity | Nullable | False | False | - ## Job +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -361,8 +409,10 @@ parallelism | Nullable>> | False | False | - pod_template | PodTemplateSpec | False | False | - selector | Nullable | False | False | - ## RouteDestService -#### Parents: [RouteDest](#routedest) -#### Parent types: [Route](#route) +#### Parents: +- [RouteDest](#routedest) +#### Parent types: +- [Route](#route) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -370,8 +420,10 @@ Name | Type | Identifier | Abstract | Mapping name | Identifier | False | False | - weight | Positive> | False | False | - ## DCRecreateStrategy -#### Parents: [DCBaseUpdateStrategy](#dcbaseupdatestrategy) -#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Parents: +- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +#### Parent types: +- [DeploymentConfig](#deploymentconfig) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -383,8 +435,10 @@ labels | Map | False | False | - recreateParams | Nullable | False | False | - resources | Nullable | False | False | - ## DplRollingUpdateStrategy -#### Parents: [DplBaseUpdateStrategy](#dplbaseupdatestrategy) -#### Parent types: [Deployment](#deployment) +#### Parents: +- [DplBaseUpdateStrategy](#dplbaseupdatestrategy) +#### Parent types: +- [Deployment](#deployment) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -392,8 +446,10 @@ Name | Type | Identifier | Abstract | Mapping maxSurge | SurgeSpec | False | False | - maxUnavailable | SurgeSpec | False | False | - ## ContainerSpec -#### Parents: [EnvironmentPreProcessMixin](#environmentpreprocessmixin) -#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Parents: +- [EnvironmentPreProcessMixin](#environmentpreprocessmixin) +#### Parent types: +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -414,22 +470,31 @@ securityContext | Nullable | False | False | - terminationMessagePath | Nullable> | False | False | - volumeMounts | Nullable> | False | True | - ## DplRecreateStrategy -#### Parents: [DplBaseUpdateStrategy](#dplbaseupdatestrategy) -#### Parent types: [Deployment](#deployment) +#### Parents: +- [DplBaseUpdateStrategy](#dplbaseupdatestrategy) +#### Parent types: +- [Deployment](#deployment) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- ## DCTrigger -#### Children: [DCConfigChangeTrigger](#dcconfigchangetrigger), [DCImageChangeTrigger](#dcimagechangetrigger) -#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Children: +- [DCConfigChangeTrigger](#dcconfigchangetrigger) +- [DCImageChangeTrigger](#dcimagechangetrigger) +#### Parent types: +- [DeploymentConfig](#deploymentconfig) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- ## ContainerEnvSecretSpec -#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Parents: +- [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -438,16 +503,24 @@ key | NonEmpty | False | False | - name | EnvString | False | False | - secret_name | Identifier | False | False | - ## MatchExpressionsSelector -#### Parents: [BaseSelector](#baseselector) -#### Parent types: [DaemonSet](#daemonset), [Deployment](#deployment), [Job](#job), [PersistentVolumeClaim](#persistentvolumeclaim) +#### Parents: +- [BaseSelector](#baseselector) +#### Parent types: +- [DaemonSet](#daemonset) +- [Deployment](#deployment) +- [Job](#job) +- [PersistentVolumeClaim](#persistentvolumeclaim) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- matchExpressions | NonEmpty> | False | False | - ## ContainerProbeBaseSpec -#### Children: [ContainerProbeTCPPortSpec](#containerprobetcpportspec), [ContainerProbeHTTPSpec](#containerprobehttpspec) -#### Parent types: [ContainerSpec](#containerspec) +#### Children: +- [ContainerProbeTCPPortSpec](#containerprobetcpportspec) +- [ContainerProbeHTTPSpec](#containerprobehttpspec) +#### Parent types: +- [ContainerSpec](#containerspec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -458,16 +531,18 @@ periodSeconds | Nullable>> | False | False | - successThreshold | Nullable>> | False | False | - timeoutSeconds | Nullable>> | False | False | - ## PodVolumeEmptyDirSpec -#### Parents: [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Parents: +- [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- name | Identifier | False | False | - ## PolicyBinding +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -478,8 +553,8 @@ Name | Type | Identifier | Abstract | Mapping name | ColonIdentifier | True | False | - roleBindings | List | False | True | - ## ConfigMap +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -490,7 +565,8 @@ Name | Type | Identifier | Abstract | Mapping name | Identifier | True | False | - files | Map | False | False | - ## SCCGroups -#### Parent types: [SecurityContextConstraints](#securitycontextconstraints) +#### Parent types: +- [SecurityContextConstraints](#securitycontextconstraints) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -498,8 +574,10 @@ Name | Type | Identifier | Abstract | Mapping ranges | Nullable> | False | False | - type | Nullable | False | False | - ## DCCustomStrategy -#### Parents: [DCBaseUpdateStrategy](#dcbaseupdatestrategy) -#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Parents: +- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +#### Parent types: +- [DeploymentConfig](#deploymentconfig) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -510,7 +588,8 @@ customParams | DCCustomParams | False | False | - labels | Map | False | False | - resources | Nullable | False | False | - ## ContainerResourceEachSpec -#### Parent types: [ContainerResourceSpec](#containerresourcespec) +#### Parent types: +- [ContainerResourceSpec](#containerresourcespec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -518,8 +597,8 @@ Name | Type | Identifier | Abstract | Mapping cpu | Nullable>> | False | True | - memory | Nullable | False | False | - ## StorageClass +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -531,7 +610,8 @@ name | Identifier | True | False | - parameters | Map | False | False | - provisioner | String | False | False | - ## DCRollingParams -#### Parent types: [DCRollingStrategy](#dcrollingstrategy) +#### Parent types: +- [DCRollingStrategy](#dcrollingstrategy) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -544,7 +624,8 @@ pre | Nullable | False | False | - timeoutSeconds | Nullable>> | False | False | - updatePeriodSeconds | Nullable>> | False | False | - ## SCCGroupRange -#### Parent types: [SCCGroups](#sccgroups) +#### Parent types: +- [SCCGroups](#sccgroups) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -552,8 +633,12 @@ Name | Type | Identifier | Abstract | Mapping max | Positive> | False | False | - min | Positive> | False | False | - ## DCCustomParams -#### Parents: [EnvironmentPreProcessMixin](#environmentpreprocessmixin) -#### Parent types: [DCCustomStrategy](#dccustomstrategy), [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy) +#### Parents: +- [EnvironmentPreProcessMixin](#environmentpreprocessmixin) +#### Parent types: +- [DCCustomStrategy](#dccustomstrategy) +- [DCRecreateStrategy](#dcrecreatestrategy) +- [DCRollingStrategy](#dcrollingstrategy) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -562,7 +647,9 @@ command | Nullable> | False | False | - environment | Nullable> | False | True | - image | NonEmpty | False | False | - ## ContainerVolumeMountSpec -#### Parent types: [ContainerSpec](#containerspec), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Parent types: +- [ContainerSpec](#containerspec) +- [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -571,14 +658,18 @@ name | Identifier | False | False | - path | NonEmpty | False | False | - readOnly | Nullable | False | False | - ## LifeCycleProbe -#### Children: [LifeCycleExec](#lifecycleexec), [LifeCycleHTTP](#lifecyclehttp) -#### Parent types: [LifeCycle](#lifecycle) +#### Children: +- [LifeCycleExec](#lifecycleexec) +- [LifeCycleHTTP](#lifecyclehttp) +#### Parent types: +- [LifeCycle](#lifecycle) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- ## SASecretSubject -#### Parent types: [ServiceAccount](#serviceaccount) +#### Parent types: +- [ServiceAccount](#serviceaccount) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -587,9 +678,14 @@ kind | Nullable | False | False | - name | Nullable | False | False | - ns | Nullable | False | False | - ## PodTemplateSpec -#### Parent types: [DaemonSet](#daemonset), [DeploymentConfig](#deploymentconfig), [Deployment](#deployment), [Job](#job), [ReplicationController](#replicationcontroller) +#### Parent types: +- [DaemonSet](#daemonset) +- [Deployment](#deployment) +- [DeploymentConfig](#deploymentconfig) +- [Job](#job) +- [ReplicationController](#replicationcontroller) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -611,8 +707,8 @@ serviceAccountName | Nullable | False | True | [serviceAccount](#ser terminationGracePeriodSeconds | Nullable> | False | False | - volumes | Nullable> | False | False | - ## User +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -624,8 +720,12 @@ name | UserIdentifier | True | False | - fullName | Nullable | False | False | - identities | NonEmpty>> | False | False | - ## ContainerEnvConfigMapSpec -#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Parents: +- [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -634,16 +734,20 @@ key | NonEmpty | False | False | - map_name | Identifier | False | False | - name | EnvString | False | False | - ## LifeCycleExec -#### Parents: [LifeCycleProbe](#lifecycleprobe) -#### Parent types: [LifeCycle](#lifecycle) +#### Parents: +- [LifeCycleProbe](#lifecycleprobe) +#### Parent types: +- [LifeCycle](#lifecycle) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- command | NonEmpty> | False | False | - ## DCRollingStrategy -#### Parents: [DCBaseUpdateStrategy](#dcbaseupdatestrategy) -#### Parent types: [DeploymentConfig](#deploymentconfig) +#### Parents: +- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +#### Parent types: +- [DeploymentConfig](#deploymentconfig) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -655,16 +759,22 @@ labels | Map | False | False | - resources | Nullable | False | False | - rollingParams | Nullable | False | False | - ## RouteDest -#### Children: [RouteDestService](#routedestservice) -#### Parent types: [Route](#route) +#### Children: +- [RouteDestService](#routedestservice) +#### Parent types: +- [Route](#route) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- weight | Positive> | False | False | - ## ContainerEnvPodFieldSpec -#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Parents: +- [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -673,8 +783,8 @@ apiVersion | Nullable | False | False | - fieldPath | Enum(u'metadata.name', u'metadata.namespace', u'metadata.labels', u'metadata.annotations', u'spec.nodeName', u'spec.serviceAccountName', u'status.podIP') | False | False | - name | EnvString | False | False | - ## ServiceAccount +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -686,17 +796,25 @@ name | Identifier | True | False | - imagePullSecrets | Nullable> | False | True | - secrets | Nullable> | False | True | - ## PodVolumeBaseSpec -#### Children: [PodVolumeHostSpec](#podvolumehostspec), [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumePVCSpec](#podvolumepvcspec), [PodVolumeEmptyDirSpec](#podvolumeemptydirspec), [PodVolumeConfigMapSpec](#podvolumeconfigmapspec), [PodVolumeSecretSpec](#podvolumesecretspec) -#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Children: +- [PodVolumeHostSpec](#podvolumehostspec) +- [PodVolumeItemMapper](#podvolumeitemmapper) +- [PodVolumePVCSpec](#podvolumepvcspec) +- [PodVolumeEmptyDirSpec](#podvolumeemptydirspec) +- [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) +- [PodVolumeSecretSpec](#podvolumesecretspec) +#### Parent types: +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- name | Identifier | False | False | - ## ClusterRole -#### Parents: [RoleBase](#rolebase) +#### Parents: +- [RoleBase](#rolebase) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -707,7 +825,9 @@ Name | Type | Identifier | Abstract | Mapping name | Identifier | True | False | - rules | NonEmpty> | False | False | - ## DCLifecycleHook -#### Parent types: [DCRecreateParams](#dcrecreateparams), [DCRollingParams](#dcrollingparams) +#### Parent types: +- [DCRecreateParams](#dcrecreateparams) +- [DCRollingParams](#dcrollingparams) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -716,9 +836,10 @@ execNewPod | Nullable | False | False | - failurePolicy | Enum(u'Abort', u'Retry', u'Ignore') | False | False | - tagImages | Nullable | False | False | - ## ClusterIPService -#### Parents: [Service](#service) +#### Parents: +- [Service](#service) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -732,7 +853,8 @@ ports | NonEmpty> | False | True | - selector | NonEmpty> | False | True | - sessionAffinity | Nullable | False | False | - ## PersistentVolumeRef -#### Parent types: [PersistentVolume](#persistentvolume) +#### Parent types: +- [PersistentVolume](#persistentvolume) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -742,8 +864,10 @@ kind | Nullable | False | False | - name | Nullable | False | False | - ns | Nullable | False | False | - ## DCLifecycleNewPod -#### Parents: [EnvironmentPreProcessMixin](#environmentpreprocessmixin) -#### Parent types: [DCLifecycleHook](#dclifecyclehook) +#### Parents: +- [EnvironmentPreProcessMixin](#environmentpreprocessmixin) +#### Parent types: +- [DCLifecycleHook](#dclifecyclehook) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -754,8 +878,10 @@ env | Nullable> | False | True | - volumeMounts | Nullable> | False | False | - volumes | Nullable> | False | False | - ## ContainerProbeTCPPortSpec -#### Parents: [ContainerProbeBaseSpec](#containerprobebasespec) -#### Parent types: [ContainerSpec](#containerspec) +#### Parents: +- [ContainerProbeBaseSpec](#containerprobebasespec) +#### Parent types: +- [ContainerSpec](#containerspec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -767,16 +893,26 @@ port | Positive> | False | True | - successThreshold | Nullable>> | False | False | - timeoutSeconds | Nullable>> | False | False | - ## ContainerEnvBaseSpec -#### Children: [ContainerEnvSpec](#containerenvspec), [ContainerEnvConfigMapSpec](#containerenvconfigmapspec), [ContainerEnvSecretSpec](#containerenvsecretspec), [ContainerEnvPodFieldSpec](#containerenvpodfieldspec), [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) -#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Children: +- [ContainerEnvSpec](#containerenvspec) +- [ContainerEnvConfigMapSpec](#containerenvconfigmapspec) +- [ContainerEnvSecretSpec](#containerenvsecretspec) +- [ContainerEnvPodFieldSpec](#containerenvpodfieldspec) +- [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) +#### Parent types: +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- name | EnvString | False | False | - ## PodVolumeHostSpec -#### Parents: [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Parents: +- [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -784,7 +920,8 @@ Name | Type | Identifier | Abstract | Mapping name | Identifier | False | False | - path | String | False | False | - ## DCRecreateParams -#### Parent types: [DCRecreateStrategy](#dcrecreatestrategy) +#### Parent types: +- [DCRecreateStrategy](#dcrecreatestrategy) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -794,7 +931,8 @@ post | Nullable | False | False | - pre | Nullable | False | False | - timeoutSeconds | Nullable>> | False | False | - ## DCTagImages -#### Parent types: [DCLifecycleHook](#dclifecyclehook) +#### Parent types: +- [DCLifecycleHook](#dclifecyclehook) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -808,9 +946,11 @@ toNamespace | Nullable | False | False | - toResourceVersion | Nullable | False | False | - toUid | Nullable | False | False | - ## Secret -#### Children: [DockerCredentials](#dockercredentials), [TLSCredentials](#tlscredentials) +#### Children: +- [DockerCredentials](#dockercredentials) +- [TLSCredentials](#tlscredentials) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -822,22 +962,31 @@ name | Identifier | True | False | - secrets | Map | False | False | - type | NonEmpty | False | False | - ## RouteDestPort -#### Parent types: [Route](#route) +#### Parent types: +- [Route](#route) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- targetPort | Identifier | False | False | - ## BaseSelector -#### Children: [MatchLabelsSelector](#matchlabelsselector), [MatchExpressionsSelector](#matchexpressionsselector) -#### Parent types: [DaemonSet](#daemonset), [Deployment](#deployment), [Job](#job), [PersistentVolumeClaim](#persistentvolumeclaim) +#### Children: +- [MatchLabelsSelector](#matchlabelsselector) +- [MatchExpressionsSelector](#matchexpressionsselector) +#### Parent types: +- [DaemonSet](#daemonset) +- [Deployment](#deployment) +- [Job](#job) +- [PersistentVolumeClaim](#persistentvolumeclaim) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- ## ContainerProbeHTTPSpec -#### Parents: [ContainerProbeBaseSpec](#containerprobebasespec) -#### Parent types: [ContainerSpec](#containerspec) +#### Parents: +- [ContainerProbeBaseSpec](#containerprobebasespec) +#### Parent types: +- [ContainerSpec](#containerspec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -852,7 +1001,10 @@ scheme | Nullable | False | False | - successThreshold | Nullable>> | False | False | - timeoutSeconds | Nullable>> | False | False | - ## ServicePort -#### Parent types: [AWSLoadBalancerService](#awsloadbalancerservice), [ClusterIPService](#clusteripservice), [Service](#service) +#### Parent types: +- [AWSLoadBalancerService](#awsloadbalancerservice) +- [ClusterIPService](#clusteripservice) +- [Service](#service) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -862,7 +1014,8 @@ port | Positive> | False | False | - protocol | Enum(u'TCP', u'UDP') | False | False | - targetPort | OneOf>, Identifier> | False | False | - ## AWSElasticBlockStore -#### Parent types: [PersistentVolume](#persistentvolume) +#### Parent types: +- [PersistentVolume](#persistentvolume) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -870,8 +1023,8 @@ Name | Type | Identifier | Abstract | Mapping fsType | Enum(u'ext4') | False | False | - volumeID | AWSVolID | False | False | - ## ReplicationController +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -885,15 +1038,16 @@ pod_template | PodTemplateSpec | False | False | - replicas | Positive> | False | False | - selector | Nullable> | False | False | - ## SAImgPullSecretSubject -#### Parent types: [ServiceAccount](#serviceaccount) +#### Parent types: +- [ServiceAccount](#serviceaccount) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- name | Identifier | False | False | - ## Deployment +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -911,14 +1065,19 @@ revisionHistoryLimit | Nullable>> | False | False | - selector | Nullable | False | False | - strategy | Nullable | False | False | - ## PodImagePullSecret -#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Parent types: +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- name | Identifier | False | False | - ## RoleSubject -#### Parent types: [ClusterRoleBinding](#clusterrolebinding), [PolicyBindingRoleBinding](#policybindingrolebinding), [RoleBindingBase](#rolebindingbase), [RoleBinding](#rolebinding) +#### Parent types: +- [ClusterRoleBinding](#clusterrolebinding) +- [PolicyBindingRoleBinding](#policybindingrolebinding) +- [RoleBinding](#rolebinding) +- [RoleBindingBase](#rolebindingbase) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -927,8 +1086,8 @@ kind | CaseIdentifier | False | False | - name | String | False | False | - ns | Nullable | False | False | - ## SecurityContextConstraints +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -957,8 +1116,8 @@ supplementalGroups | Nullable | False | False | - users | List | False | False | - volumes | List | False | False | - ## Route +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -973,7 +1132,12 @@ tls | Nullable | False | False | - to | NonEmpty> | False | False | - wildcardPolicy | Enum(u'Subdomain', u'None') | False | False | - ## ContainerResourceSpec -#### Parent types: [ContainerSpec](#containerspec), [DCBaseUpdateStrategy](#dcbaseupdatestrategy), [DCCustomStrategy](#dccustomstrategy), [DCRecreateStrategy](#dcrecreatestrategy), [DCRollingStrategy](#dcrollingstrategy) +#### Parent types: +- [ContainerSpec](#containerspec) +- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +- [DCCustomStrategy](#dccustomstrategy) +- [DCRecreateStrategy](#dcrecreatestrategy) +- [DCRollingStrategy](#dcrollingstrategy) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -981,8 +1145,10 @@ Name | Type | Identifier | Abstract | Mapping limits | ContainerResourceEachSpec | False | False | - requests | ContainerResourceEachSpec | False | False | - ## PolicyBindingRoleBinding -#### Parents: [RoleBindingXF](#rolebindingxf) -#### Parent types: [PolicyBinding](#policybinding) +#### Parents: +- [RoleBindingXF](#rolebindingxf) +#### Parent types: +- [PolicyBinding](#policybinding) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -993,7 +1159,8 @@ ns | Identifier | False | False | - roleRef | RoleRef | False | True | - subjects | NonEmpty> | False | True | - ## LifeCycle -#### Parent types: [ContainerSpec](#containerspec) +#### Parent types: +- [ContainerSpec](#containerspec) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -1001,9 +1168,11 @@ Name | Type | Identifier | Abstract | Mapping postStart | Nullable | False | False | - preStop | Nullable | False | False | - ## RoleBinding -#### Parents: [RoleBindingBase](#rolebindingbase), [RoleBindingXF](#rolebindingxf) +#### Parents: +- [RoleBindingBase](#rolebindingbase) +- [RoleBindingXF](#rolebindingxf) +#### Metadata ``` - metadata: annotations: Map labels: Map ``` @@ -1015,15 +1184,23 @@ name | SystemIdentifier | True | False | - roleRef | RoleRef | False | True | - subjects | NonEmpty> | False | True | - ## MatchLabelsSelector -#### Parents: [BaseSelector](#baseselector) -#### Parent types: [DaemonSet](#daemonset), [Deployment](#deployment), [Job](#job), [PersistentVolumeClaim](#persistentvolumeclaim) +#### Parents: +- [BaseSelector](#baseselector) +#### Parent types: +- [DaemonSet](#daemonset) +- [Deployment](#deployment) +- [Job](#job) +- [PersistentVolumeClaim](#persistentvolumeclaim) #### Properties: Name | Type | Identifier | Abstract | Mapping ---- | ---- | ---------- | -------- | ------- matchLabels | Map | False | False | - ## PolicyRule -#### Parent types: [ClusterRole](#clusterrole), [RoleBase](#rolebase), [Role](#role) +#### Parent types: +- [ClusterRole](#clusterrole) +- [Role](#role) +- [RoleBase](#rolebase) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -1035,8 +1212,12 @@ resourceNames | Nullable> | False | False | - resources | NonEmpty>> | False | False | - verbs | NonEmpty> | False | False | - ## ContainerEnvContainerResourceSpec -#### Parents: [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: [ContainerSpec](#containerspec), [DCCustomParams](#dccustomparams), [DCLifecycleNewPod](#dclifecyclenewpod) +#### Parents: +- [ContainerEnvBaseSpec](#containerenvbasespec) +#### Parent types: +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: Name | Type | Identifier | Abstract | Mapping @@ -1046,8 +1227,11 @@ divisor | Nullable> | False | False | - name | EnvString | False | False | - resource | Enum(u'limits.cpu', u'limits.memory', u'requests.cpu', u'requests.memory') | False | False | - ## PodVolumeSecretSpec -#### Parents: [PodVolumeItemMapper](#podvolumeitemmapper), [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: [PodTemplateSpec](#podtemplatespec) +#### Parents: +- [PodVolumeItemMapper](#podvolumeitemmapper) +- [PodVolumeBaseSpec](#podvolumebasespec) +#### Parent types: +- [PodTemplateSpec](#podtemplatespec) #### Properties: Name | Type | Identifier | Abstract | Mapping From 51c413679d436c0024f84ba852cd92f8ea193c65 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 5 Jul 2018 15:03:56 +0200 Subject: [PATCH 08/40] Some fix to md --- docs/rubiks.class.md | 994 +++++++++++++++++++++---------------------- lib/kube_help.py | 49 ++- lib/kube_obj.py | 7 +- lib/kube_types.py | 7 +- 4 files changed, 535 insertions(+), 522 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 602c02a..d417b77 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -8,13 +8,13 @@ ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -secrets | Map | False | False | - -tls_cert | String | False | False | - -tls_key | String | False | False | - -type | NonEmpty | False | False | - +secrets | Map<String, String> | False | - | - +tls_cert | String | False | - | - +tls_key | String | False | - | - +type | NonEmpty<String> | False | - | - ## Service #### Children: - [ClusterIPService](#clusteripservice) @@ -26,12 +26,12 @@ type | NonEmpty | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -ports | NonEmpty> | False | True | - -selector | NonEmpty> | False | True | - -sessionAffinity | Nullable | False | False | - +ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - +selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - +sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ## DockerCredentials #### Parents: - [Secret](#secret) @@ -42,22 +42,18 @@ sessionAffinity | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -dockers | Map> | False | False | - -secrets | Map | False | False | - -type | NonEmpty | False | False | - +dockers | Map<String, Map<String, String>> | False | - | - +secrets | Map<String, String> | False | - | - +type | NonEmpty<String> | False | - | - ## DplBaseUpdateStrategy #### Children: - [DplRecreateStrategy](#dplrecreatestrategy) - [DplRollingUpdateStrategy](#dplrollingupdatestrategy) #### Parent types: - [Deployment](#deployment) -#### Properties: - -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- ## Role #### Parents: - [RoleBase](#rolebase) @@ -68,10 +64,10 @@ Name | Type | Identifier | Abstract | Mapping ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -rules | NonEmpty> | False | False | - +rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ## Group #### Metadata ``` @@ -80,34 +76,34 @@ rules | NonEmpty> | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -users | NonEmpty> | False | False | - +users | NonEmpty<List<UserIdentifier>> | False | - | - ## RouteTLS #### Parent types: - [Route](#route) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -caCertificate | Nullable> | False | False | - -certificate | Nullable> | False | False | - -destinationCACertificate | Nullable> | False | False | - -insecureEdgeTerminationPolicy | Enum(u'Allow', u'Disable', u'Redirect') | False | False | - -key | Nullable> | False | False | - -termination | Enum(u'edge', u'reencrypt', u'passthrough') | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +caCertificate | Nullable<NonEmpty<String>> | False | - | - +certificate | Nullable<NonEmpty<String>> | False | - | - +destinationCACertificate | Nullable<NonEmpty<String>> | False | - | - +insecureEdgeTerminationPolicy | Enum('Allow', 'Disable', 'Redirect') | False | - | - +key | Nullable<NonEmpty<String>> | False | - | - +termination | Enum('edge', 'reencrypt', 'passthrough') | False | - | - ## SCCRunAsUser #### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -type | Enum(u'MustRunAs', u'RunAsAny', u'MustRunAsRange', u'MustRunAsNonRoot') | False | False | - -uid | Nullable>> | False | False | - -uidRangeMax | Nullable>> | False | False | - -uidRangeMin | Nullable>> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +type | Enum('MustRunAs', 'RunAsAny', 'MustRunAsRange', 'MustRunAsNonRoot') | False | - | - +uid | Nullable<Positive<NonZero<Integer>>> | False | - | - +uidRangeMax | Nullable<Positive<NonZero<Integer>>> | False | - | - +uidRangeMin | Nullable<Positive<NonZero<Integer>>> | False | - | - ## PersistentVolumeClaim #### Metadata ``` @@ -116,13 +112,13 @@ uidRangeMin | Nullable>> | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -accessModes | List | False | False | - -request | Memory | False | False | - -selector | Nullable | False | False | - -volumeName | Nullable | False | True | - +accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - +request | Memory | False | - | - +selector | Nullable<[BaseSelector](#baseselector)> | False | - | - +volumeName | Nullable<Identifier> | False | <unknown transformation> | - ## PodVolumePVCSpec #### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) @@ -130,32 +126,28 @@ volumeName | Nullable | False | True | - - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -claimName | Identifier | False | False | - -name | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +claimName | Identifier | False | - | - +name | Identifier | False | - | - ## DCConfigChangeTrigger #### Parents: - [DCTrigger](#dctrigger) #### Parent types: - [DeploymentConfig](#deploymentconfig) -#### Properties: - -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- ## SecurityContext #### Parent types: - [ContainerSpec](#containerspec) - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -fsGroup | Nullable | False | False | - -privileged | Nullable | False | False | - -runAsNonRoot | Nullable | False | False | - -runAsUser | Nullable | False | False | - -supplementalGroups | Nullable> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +fsGroup | Nullable<Integer> | False | - | - +privileged | Nullable<Boolean> | False | - | - +runAsNonRoot | Nullable<Boolean> | False | - | - +runAsUser | Nullable<Integer> | False | - | - +supplementalGroups | Nullable<List<Integer>> | False | - | - ## Project #### Parents: - [Namespace](#namespace) @@ -166,8 +158,8 @@ supplementalGroups | Nullable> | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - ## PersistentVolume #### Metadata @@ -177,14 +169,14 @@ name | Identifier | True | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -accessModes | List | False | False | - -awsElasticBlockStore | Nullable | False | False | - -capacity | Memory | False | False | - -claimRef | Nullable | False | False | - -persistentVolumeReclaimPolicy | Nullable | False | False | - +accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - +awsElasticBlockStore | Nullable<[AWSElasticBlockStore](#awselasticblockstore)> | False | - | - +capacity | Memory | False | - | - +claimRef | Nullable<[PersistentVolumeRef](#persistentvolumeref)> | False | - | - +persistentVolumeReclaimPolicy | Nullable<Enum('Retain', 'Recycle', 'Delete')> | False | - | - ## DeploymentConfig #### Metadata ``` @@ -193,39 +185,35 @@ persistentVolumeReclaimPolicy | Nullable ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -minReadySeconds | Nullable>> | False | False | - -paused | Nullable | False | False | - -pod_template | PodTemplateSpec | False | False | - -replicas | Positive> | False | False | - -revisionHistoryLimit | Nullable>> | False | False | - -selector | Nullable> | False | False | - -strategy | DCBaseUpdateStrategy | False | False | - -test | Boolean | False | False | - -triggers | List | False | False | - +minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +paused | Nullable<Boolean> | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +replicas | Positive<NonZero<Integer>> | False | - | - +revisionHistoryLimit | Nullable<Positive<NonZero<Integer>>> | False | - | - +selector | Nullable<Map<String, String>> | False | - | - +strategy | [DCBaseUpdateStrategy](#dcbaseupdatestrategy) | False | - | - +test | Boolean | False | - | - +triggers | List<[DCTrigger](#dctrigger)> | False | - | - ## ContainerPort #### Parent types: - [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -containerPort | Positive> | False | False | - -hostIP | Nullable | False | False | - -hostPort | Nullable>> | False | False | - -name | Nullable | False | False | - -protocol | Enum(u'TCP', u'UDP') | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +containerPort | Positive<NonZero<Integer>> | False | - | - +hostIP | Nullable<IP> | False | - | - +hostPort | Nullable<Positive<NonZero<Integer>>> | False | - | - +name | Nullable<String> | False | - | - +protocol | Enum('TCP', 'UDP') | False | - | - ## DCImageChangeTrigger #### Parents: - [DCTrigger](#dctrigger) #### Parent types: - [DeploymentConfig](#deploymentconfig) -#### Properties: - -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- ## RoleRef #### Parent types: - [ClusterRoleBinding](#clusterrolebinding) @@ -234,10 +222,10 @@ Name | Type | Identifier | Abstract | Mapping - [RoleBindingBase](#rolebindingbase) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | Nullable | False | False | - -ns | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Nullable<SystemIdentifier> | False | - | - +ns | Nullable<Identifier> | False | - | - ## LifeCycleHTTP #### Parents: - [LifeCycleProbe](#lifecycleprobe) @@ -245,11 +233,11 @@ ns | Nullable | False | False | - - [LifeCycle](#lifecycle) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -path | NonEmpty | False | False | - -port | Positive> | False | False | - -scheme | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +path | NonEmpty<Path> | False | - | - +port | Positive<NonZero<Integer>> | False | - | - +scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - ## PodVolumeItemMapper #### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) @@ -260,10 +248,10 @@ scheme | Nullable | False | False | - - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -item_map | Nullable> | False | False | - -name | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +item_map | Nullable<Map<String, String>> | False | - | - +name | Identifier | False | - | - ## DaemonSet #### Parents: - [SelectorsPreProcessMixin](#selectorspreprocessmixin) @@ -274,11 +262,11 @@ name | Identifier | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -pod_template | PodTemplateSpec | False | False | - -selector | Nullable | False | True | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +selector | Nullable<[BaseSelector](#baseselector)> | False | <unknown transformation> | - ## DCBaseUpdateStrategy #### Children: - [DCRecreateStrategy](#dcrecreatestrategy) @@ -288,12 +276,12 @@ selector | Nullable | False | True | - - [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -activeDeadlineSeconds | Nullable>> | False | False | - -annotations | Map | False | False | - -labels | Map | False | False | - -resources | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +annotations | Map<String, String> | False | - | - +labels | Map<String, String> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## Namespace #### Children: - [Project](#project) @@ -304,8 +292,8 @@ resources | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - ## ContainerEnvSpec #### Parents: @@ -316,10 +304,10 @@ name | Identifier | True | False | - - [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | EnvString | False | False | - -value | String | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | EnvString | False | - | - +value | String | False | - | - ## PodVolumeConfigMapSpec #### Parents: - [PodVolumeItemMapper](#podvolumeitemmapper) @@ -328,34 +316,34 @@ value | String | False | False | - - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -defaultMode | Nullable> | False | False | - -item_map | Nullable> | False | False | - -map_name | Identifier | False | False | - -name | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +defaultMode | Nullable<Positive<Integer>> | False | - | - +item_map | Nullable<Map<String, String>> | False | - | - +map_name | Identifier | False | - | - +name | Identifier | False | - | - ## MatchExpression #### Parent types: - [MatchExpressionsSelector](#matchexpressionsselector) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -key | NonEmpty | False | False | - -operator | Enum(u'In', u'NotIn', u'Exists', u'DoesNotExist') | False | False | - -values | Nullable> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +key | NonEmpty<String> | False | - | - +operator | Enum('In', 'NotIn', 'Exists', 'DoesNotExist') | False | - | - +values | Nullable<List<String>> | False | - | - ## SCCSELinux #### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -level | Nullable | False | False | - -role | Nullable | False | False | - -strategy | Nullable | False | False | - -type | Nullable | False | False | - -user | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +level | Nullable<String> | False | - | - +role | Nullable<String> | False | - | - +strategy | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - +type | Nullable<String> | False | - | - +user | Nullable<String> | False | - | - ## ClusterRoleBinding #### Parents: - [RoleBindingBase](#rolebindingbase) @@ -367,11 +355,11 @@ user | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -roleRef | RoleRef | False | True | - -subjects | NonEmpty> | False | True | - +roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - +subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## AWSLoadBalancerService #### Parents: - [Service](#service) @@ -382,15 +370,15 @@ subjects | NonEmpty> | False | True | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -aws-load-balancer-backend-protocol | Nullable | False | False | - -aws-load-balancer-ssl-cert | Nullable | False | False | - -externalTrafficPolicy | Nullable | False | False | - -ports | NonEmpty> | False | True | - -selector | NonEmpty> | False | True | - -sessionAffinity | Nullable | False | False | - +aws-load-balancer-backend-protocol | Nullable<Identifier> | False | - | - +aws-load-balancer-ssl-cert | Nullable<ARN> | False | - | - +externalTrafficPolicy | Nullable<Enum('Cluster', 'Local')> | False | - | - +ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - +selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - +sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ## Job #### Metadata ``` @@ -399,15 +387,15 @@ sessionAffinity | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -activeDeadlineSeconds | Nullable> | False | False | - -completions | Nullable>> | False | False | - -manualSelector | Nullable | False | False | - -parallelism | Nullable>> | False | False | - -pod_template | PodTemplateSpec | False | False | - -selector | Nullable | False | False | - +activeDeadlineSeconds | Nullable<Positive<Integer>> | False | - | - +completions | Nullable<Positive<NonZero<Integer>>> | False | - | - +manualSelector | Nullable<Boolean> | False | - | - +parallelism | Nullable<Positive<NonZero<Integer>>> | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +selector | Nullable<[BaseSelector](#baseselector)> | False | - | - ## RouteDestService #### Parents: - [RouteDest](#routedest) @@ -415,10 +403,10 @@ selector | Nullable | False | False | - - [Route](#route) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | Identifier | False | False | - -weight | Positive> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | False | - | - +weight | Positive<NonZero<Integer>> | False | - | - ## DCRecreateStrategy #### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) @@ -426,14 +414,14 @@ weight | Positive> | False | False | - - [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -activeDeadlineSeconds | Nullable>> | False | False | - -annotations | Map | False | False | - -customParams | Nullable | False | False | - -labels | Map | False | False | - -recreateParams | Nullable | False | False | - -resources | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +annotations | Map<String, String> | False | - | - +customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - +labels | Map<String, String> | False | - | - +recreateParams | Nullable<[DCRecreateParams](#dcrecreateparams)> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## DplRollingUpdateStrategy #### Parents: - [DplBaseUpdateStrategy](#dplbaseupdatestrategy) @@ -441,10 +429,10 @@ resources | Nullable | False | False | - - [Deployment](#deployment) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -maxSurge | SurgeSpec | False | False | - -maxUnavailable | SurgeSpec | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +maxSurge | SurgeSpec | False | - | - +maxUnavailable | SurgeSpec | False | - | - ## ContainerSpec #### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) @@ -452,42 +440,34 @@ maxUnavailable | SurgeSpec | False | False | - - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -args | Nullable> | False | False | - -command | Nullable> | False | False | - -env | Nullable> | False | True | - -image | NonEmpty | False | False | - -imagePullPolicy | Nullable | False | False | - -kind | Nullable | False | False | - -lifecycle | Nullable | False | False | - -livenessProbe | Nullable | False | False | - -ports | Nullable> | False | True | - -readinessProbe | Nullable | False | False | - -resources | Nullable | False | False | - -securityContext | Nullable | False | False | - -terminationMessagePath | Nullable> | False | False | - -volumeMounts | Nullable> | False | True | - +args | Nullable<List<String>> | False | - | - +command | Nullable<List<String>> | False | - | - +env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - +image | NonEmpty<String> | False | - | - +imagePullPolicy | Nullable<Enum('Always', 'IfNotPresent')> | False | - | - +kind | Nullable<Enum('DockerImage')> | False | - | - +lifecycle | Nullable<[LifeCycle](#lifecycle)> | False | - | - +livenessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - +ports | Nullable<List<[ContainerPort](#containerport)>> | False | <unknown transformation> | - +readinessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +securityContext | Nullable<[SecurityContext](#securitycontext)> | False | - | - +terminationMessagePath | Nullable<NonEmpty<Path>> | False | - | - +volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | <unknown transformation> | - ## DplRecreateStrategy #### Parents: - [DplBaseUpdateStrategy](#dplbaseupdatestrategy) #### Parent types: - [Deployment](#deployment) -#### Properties: - -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- ## DCTrigger #### Children: - [DCConfigChangeTrigger](#dcconfigchangetrigger) - [DCImageChangeTrigger](#dcimagechangetrigger) #### Parent types: - [DeploymentConfig](#deploymentconfig) -#### Properties: - -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- ## ContainerEnvSecretSpec #### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -497,11 +477,11 @@ Name | Type | Identifier | Abstract | Mapping - [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -key | NonEmpty | False | False | - -name | EnvString | False | False | - -secret_name | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +key | NonEmpty<String> | False | - | - +name | EnvString | False | - | - +secret_name | Identifier | False | - | - ## MatchExpressionsSelector #### Parents: - [BaseSelector](#baseselector) @@ -512,9 +492,9 @@ secret_name | Identifier | False | False | - - [PersistentVolumeClaim](#persistentvolumeclaim) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -matchExpressions | NonEmpty> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +matchExpressions | NonEmpty<List<[MatchExpression](#matchexpression)>> | False | - | - ## ContainerProbeBaseSpec #### Children: - [ContainerProbeTCPPortSpec](#containerprobetcpportspec) @@ -523,13 +503,13 @@ matchExpressions | NonEmpty> | False | False | - - [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -failureThreshold | Nullable>> | False | False | - -initialDelaySeconds | Nullable> | False | False | - -periodSeconds | Nullable>> | False | False | - -successThreshold | Nullable>> | False | False | - -timeoutSeconds | Nullable>> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - +periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## PodVolumeEmptyDirSpec #### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) @@ -537,9 +517,9 @@ timeoutSeconds | Nullable>> | False | False | - - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | False | - | - ## PolicyBinding #### Metadata ``` @@ -548,10 +528,10 @@ name | Identifier | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | ColonIdentifier | True | False | - -roleBindings | List | False | True | - +roleBindings | List<[PolicyBindingRoleBinding](#policybindingrolebinding)> | False | <unknown transformation> | - ## ConfigMap #### Metadata ``` @@ -560,19 +540,19 @@ roleBindings | List | False | True | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -files | Map | False | False | - +files | Map<String, String> | False | - | - ## SCCGroups #### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -ranges | Nullable> | False | False | - -type | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +ranges | Nullable<List<[SCCGroupRange](#sccgrouprange)>> | False | - | - +type | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - ## DCCustomStrategy #### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) @@ -580,22 +560,22 @@ type | Nullable | False | False | - - [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -activeDeadlineSeconds | Nullable>> | False | False | - -annotations | Map | False | False | - -customParams | DCCustomParams | False | False | - -labels | Map | False | False | - -resources | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +annotations | Map<String, String> | False | - | - +customParams | [DCCustomParams](#dccustomparams) | False | - | - +labels | Map<String, String> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## ContainerResourceEachSpec #### Parent types: - [ContainerResourceSpec](#containerresourcespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -cpu | Nullable>> | False | True | - -memory | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +cpu | Nullable<Positive<NonZero<Number>>> | False | <unknown transformation> | - +memory | Nullable<Memory> | False | - | - ## StorageClass #### Metadata ``` @@ -604,34 +584,34 @@ memory | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -parameters | Map | False | False | - -provisioner | String | False | False | - +parameters | Map<String, String> | False | - | - +provisioner | String | False | - | - ## DCRollingParams #### Parent types: - [DCRollingStrategy](#dcrollingstrategy) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -intervalSeconds | Nullable>> | False | False | - -maxSurge | SurgeSpec | False | False | - -maxUnavailable | SurgeSpec | False | False | - -post | Nullable | False | False | - -pre | Nullable | False | False | - -timeoutSeconds | Nullable>> | False | False | - -updatePeriodSeconds | Nullable>> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +intervalSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +maxSurge | SurgeSpec | False | - | - +maxUnavailable | SurgeSpec | False | - | - +post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +updatePeriodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## SCCGroupRange #### Parent types: - [SCCGroups](#sccgroups) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -max | Positive> | False | False | - -min | Positive> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +max | Positive<NonZero<Integer>> | False | - | - +min | Positive<NonZero<Integer>> | False | - | - ## DCCustomParams #### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) @@ -641,42 +621,38 @@ min | Positive> | False | False | - - [DCRollingStrategy](#dcrollingstrategy) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -command | Nullable> | False | False | - -environment | Nullable> | False | True | - -image | NonEmpty | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +command | Nullable<List<String>> | False | - | - +environment | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - +image | NonEmpty<String> | False | - | - ## ContainerVolumeMountSpec #### Parent types: - [ContainerSpec](#containerspec) - [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | Identifier | False | False | - -path | NonEmpty | False | False | - -readOnly | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | False | - | - +path | NonEmpty<Path> | False | - | - +readOnly | Nullable<Boolean> | False | - | - ## LifeCycleProbe #### Children: - [LifeCycleExec](#lifecycleexec) - [LifeCycleHTTP](#lifecyclehttp) #### Parent types: - [LifeCycle](#lifecycle) -#### Properties: - -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- ## SASecretSubject #### Parent types: - [ServiceAccount](#serviceaccount) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -kind | Nullable | False | False | - -name | Nullable | False | False | - -ns | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +kind | Nullable<CaseIdentifier> | False | - | - +name | Nullable<Identifier> | False | - | - +ns | Nullable<Identifier> | False | - | - ## PodTemplateSpec #### Parent types: - [DaemonSet](#daemonset) @@ -691,21 +667,21 @@ ns | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -containers | NonEmpty> | False | False | - -dnsPolicy | Nullable | False | False | - -hostIPC | Nullable | False | False | - -hostNetwork | Nullable | False | False | - -hostPID | Nullable | False | False | - -imagePullSecrets | Nullable> | False | True | - -name | Nullable | False | False | - -nodeSelector | Nullable> | False | False | - -restartPolicy | Nullable | False | False | - -securityContext | Nullable | False | False | - -serviceAccountName | Nullable | False | True | [serviceAccount](#serviceaccount) -terminationGracePeriodSeconds | Nullable> | False | False | - -volumes | Nullable> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +containers | NonEmpty<List<[ContainerSpec](#containerspec)>> | False | - | - +dnsPolicy | Nullable<Enum('ClusterFirst')> | False | - | - +hostIPC | Nullable<Boolean> | False | - | - +hostNetwork | Nullable<Boolean> | False | - | - +hostPID | Nullable<Boolean> | False | - | - +imagePullSecrets | Nullable<List<[PodImagePullSecret](#podimagepullsecret)>> | False | <unknown transformation> | - +name | Nullable<Identifier> | False | - | - +nodeSelector | Nullable<Map<String, String>> | False | - | - +restartPolicy | Nullable<Enum('Always', 'OnFailure', 'Never')> | False | - | - +securityContext | Nullable<[SecurityContext](#securitycontext)> | False | - | - +serviceAccountName | Nullable<Identifier> | False | <unknown transformation> | [serviceAccount](#serviceaccount) +terminationGracePeriodSeconds | Nullable<Positive<Integer>> | False | - | - +volumes | Nullable<List<[PodVolumeBaseSpec](#podvolumebasespec)>> | False | - | - ## User #### Metadata ``` @@ -714,11 +690,11 @@ volumes | Nullable> | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | UserIdentifier | True | False | - -fullName | Nullable | False | False | - -identities | NonEmpty>> | False | False | - +fullName | Nullable<String> | False | - | - +identities | NonEmpty<List<NonEmpty<String>>> | False | - | - ## ContainerEnvConfigMapSpec #### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -728,11 +704,11 @@ identities | NonEmpty>> | False | False | - - [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -key | NonEmpty | False | False | - -map_name | Identifier | False | False | - -name | EnvString | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +key | NonEmpty<String> | False | - | - +map_name | Identifier | False | - | - +name | EnvString | False | - | - ## LifeCycleExec #### Parents: - [LifeCycleProbe](#lifecycleprobe) @@ -740,9 +716,9 @@ name | EnvString | False | False | - - [LifeCycle](#lifecycle) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -command | NonEmpty> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +command | NonEmpty<List<String>> | False | - | - ## DCRollingStrategy #### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) @@ -750,14 +726,14 @@ command | NonEmpty> | False | False | - - [DeploymentConfig](#deploymentconfig) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -activeDeadlineSeconds | Nullable>> | False | False | - -annotations | Map | False | False | - -customParams | Nullable | False | False | - -labels | Map | False | False | - -resources | Nullable | False | False | - -rollingParams | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +annotations | Map<String, String> | False | - | - +customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - +labels | Map<String, String> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +rollingParams | Nullable<[DCRollingParams](#dcrollingparams)> | False | - | - ## RouteDest #### Children: - [RouteDestService](#routedestservice) @@ -765,9 +741,9 @@ rollingParams | Nullable | False | False | - - [Route](#route) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -weight | Positive> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +weight | Positive<NonZero<Integer>> | False | - | - ## ContainerEnvPodFieldSpec #### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -777,11 +753,11 @@ weight | Positive> | False | False | - - [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -apiVersion | Nullable | False | False | - -fieldPath | Enum(u'metadata.name', u'metadata.namespace', u'metadata.labels', u'metadata.annotations', u'spec.nodeName', u'spec.serviceAccountName', u'status.podIP') | False | False | - -name | EnvString | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +apiVersion | Nullable<Enum('v1')> | False | - | - +fieldPath | Enum('metadata.name', 'metadata.namespace', 'metadata.labels', 'metadata.annotations', 'spec.nodeName', 'spec.serviceAccountName', 'status.podIP') | False | - | - +name | EnvString | False | - | - ## ServiceAccount #### Metadata ``` @@ -790,11 +766,11 @@ name | EnvString | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -imagePullSecrets | Nullable> | False | True | - -secrets | Nullable> | False | True | - +imagePullSecrets | Nullable<List<[SAImgPullSecretSubject](#saimgpullsecretsubject)>> | False | <unknown transformation> | - +secrets | Nullable<List<[SASecretSubject](#sasecretsubject)>> | False | <unknown transformation> | - ## PodVolumeBaseSpec #### Children: - [PodVolumeHostSpec](#podvolumehostspec) @@ -807,9 +783,9 @@ secrets | Nullable> | False | True | - - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | False | - | - ## ClusterRole #### Parents: - [RoleBase](#rolebase) @@ -820,21 +796,21 @@ name | Identifier | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -rules | NonEmpty> | False | False | - +rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ## DCLifecycleHook #### Parent types: - [DCRecreateParams](#dcrecreateparams) - [DCRollingParams](#dcrollingparams) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -execNewPod | Nullable | False | False | - -failurePolicy | Enum(u'Abort', u'Retry', u'Ignore') | False | False | - -tagImages | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +execNewPod | Nullable<[DCLifecycleNewPod](#dclifecyclenewpod)> | False | - | - +failurePolicy | Enum('Abort', 'Retry', 'Ignore') | False | - | - +tagImages | Nullable<[DCTagImages](#dctagimages)> | False | - | - ## ClusterIPService #### Parents: - [Service](#service) @@ -845,24 +821,24 @@ tagImages | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -clusterIP | Nullable | False | False | - -ports | NonEmpty> | False | True | - -selector | NonEmpty> | False | True | - -sessionAffinity | Nullable | False | False | - +clusterIP | Nullable<IPv4> | False | - | - +ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - +selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - +sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ## PersistentVolumeRef #### Parent types: - [PersistentVolume](#persistentvolume) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -apiVersion | Nullable | False | False | - -kind | Nullable | False | False | - -name | Nullable | False | False | - -ns | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +apiVersion | Nullable<String> | False | - | - +kind | Nullable<CaseIdentifier> | False | - | - +name | Nullable<Identifier> | False | - | - +ns | Nullable<Identifier> | False | - | - ## DCLifecycleNewPod #### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) @@ -870,13 +846,13 @@ ns | Nullable | False | False | - - [DCLifecycleHook](#dclifecyclehook) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -command | NonEmpty> | False | False | - -containerName | Identifier | False | False | - -env | Nullable> | False | True | - -volumeMounts | Nullable> | False | False | - -volumes | Nullable> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +command | NonEmpty<List<String>> | False | - | - +containerName | Identifier | False | - | - +env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - +volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | - | - +volumes | Nullable<List<Identifier>> | False | - | - ## ContainerProbeTCPPortSpec #### Parents: - [ContainerProbeBaseSpec](#containerprobebasespec) @@ -884,14 +860,14 @@ volumes | Nullable> | False | False | - - [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -failureThreshold | Nullable>> | False | False | - -initialDelaySeconds | Nullable> | False | False | - -periodSeconds | Nullable>> | False | False | - -port | Positive> | False | True | - -successThreshold | Nullable>> | False | False | - -timeoutSeconds | Nullable>> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - +periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +port | Positive<NonZero<Integer>> | False | <unknown transformation> | - +successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## ContainerEnvBaseSpec #### Children: - [ContainerEnvSpec](#containerenvspec) @@ -905,9 +881,9 @@ timeoutSeconds | Nullable>> | False | False | - - [DCLifecycleNewPod](#dclifecyclenewpod) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | EnvString | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | EnvString | False | - | - ## PodVolumeHostSpec #### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) @@ -915,36 +891,36 @@ name | EnvString | False | False | - - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | Identifier | False | False | - -path | String | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | False | - | - +path | String | False | - | - ## DCRecreateParams #### Parent types: - [DCRecreateStrategy](#dcrecreatestrategy) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -mid | Nullable | False | False | - -post | Nullable | False | False | - -pre | Nullable | False | False | - -timeoutSeconds | Nullable>> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +mid | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## DCTagImages #### Parent types: - [DCLifecycleHook](#dclifecyclehook) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -containerName | Identifier | False | False | - -toApiVersion | Nullable | False | False | - -toFieldPath | Nullable | False | False | - -toKind | Nullable | False | False | - -toName | Nullable | False | False | - -toNamespace | Nullable | False | False | - -toResourceVersion | Nullable | False | False | - -toUid | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +containerName | Identifier | False | - | - +toApiVersion | Nullable<String> | False | - | - +toFieldPath | Nullable<String> | False | - | - +toKind | Nullable<Enum('Deployment', 'DeploymentConfig', 'ImageStreamTag')> | False | - | - +toName | Nullable<Identifier> | False | - | - +toNamespace | Nullable<Identifier> | False | - | - +toResourceVersion | Nullable<String> | False | - | - +toUid | Nullable<String> | False | - | - ## Secret #### Children: - [DockerCredentials](#dockercredentials) @@ -956,19 +932,19 @@ toUid | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -secrets | Map | False | False | - -type | NonEmpty | False | False | - +secrets | Map<String, String> | False | - | - +type | NonEmpty<String> | False | - | - ## RouteDestPort #### Parent types: - [Route](#route) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -targetPort | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +targetPort | Identifier | False | - | - ## BaseSelector #### Children: - [MatchLabelsSelector](#matchlabelsselector) @@ -978,10 +954,6 @@ targetPort | Identifier | False | False | - - [Deployment](#deployment) - [Job](#job) - [PersistentVolumeClaim](#persistentvolumeclaim) -#### Properties: - -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- ## ContainerProbeHTTPSpec #### Parents: - [ContainerProbeBaseSpec](#containerprobebasespec) @@ -989,17 +961,17 @@ Name | Type | Identifier | Abstract | Mapping - [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -failureThreshold | Nullable>> | False | False | - -host | Nullable | False | False | - -initialDelaySeconds | Nullable> | False | False | - -path | NonEmpty | False | False | - -periodSeconds | Nullable>> | False | False | - -port | Positive> | False | True | - -scheme | Nullable | False | False | - -successThreshold | Nullable>> | False | False | - -timeoutSeconds | Nullable>> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +host | Nullable<Domain> | False | - | - +initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - +path | NonEmpty<Path> | False | - | - +periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +port | Positive<NonZero<Integer>> | False | <unknown transformation> | - +scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - +successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## ServicePort #### Parent types: - [AWSLoadBalancerService](#awsloadbalancerservice) @@ -1007,21 +979,21 @@ timeoutSeconds | Nullable>> | False | False | - - [Service](#service) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | Nullable | False | False | - -port | Positive> | False | False | - -protocol | Enum(u'TCP', u'UDP') | False | False | - -targetPort | OneOf>, Identifier> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Nullable<Identifier> | False | - | - +port | Positive<NonZero<Integer>> | False | - | - +protocol | Enum('TCP', 'UDP') | False | - | - +targetPort | OneOf<Positive<NonZero<Integer>>, Identifier> | False | - | - ## AWSElasticBlockStore #### Parent types: - [PersistentVolume](#persistentvolume) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -fsType | Enum(u'ext4') | False | False | - -volumeID | AWSVolID | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +fsType | Enum('ext4') | False | - | - +volumeID | AWSVolID | False | - | - ## ReplicationController #### Metadata ``` @@ -1030,21 +1002,21 @@ volumeID | AWSVolID | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -minReadySeconds | Nullable>> | False | False | - -pod_template | PodTemplateSpec | False | False | - -replicas | Positive> | False | False | - -selector | Nullable> | False | False | - +minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +replicas | Positive<NonZero<Integer>> | False | - | - +selector | Nullable<Map<String, String>> | False | - | - ## SAImgPullSecretSubject #### Parent types: - [ServiceAccount](#serviceaccount) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | False | - | - ## Deployment #### Metadata ``` @@ -1053,25 +1025,25 @@ name | Identifier | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -minReadySeconds | Nullable>> | False | False | - -paused | Nullable | False | False | - -pod_template | PodTemplateSpec | False | False | - -progressDeadlineSeconds | Nullable>> | False | False | - -replicas | Positive> | False | False | - -revisionHistoryLimit | Nullable>> | False | False | - -selector | Nullable | False | False | - -strategy | Nullable | False | False | - +minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +paused | Nullable<Boolean> | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +progressDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +replicas | Positive<NonZero<Integer>> | False | - | - +revisionHistoryLimit | Nullable<Positive<NonZero<Integer>>> | False | - | - +selector | Nullable<[BaseSelector](#baseselector)> | False | - | - +strategy | Nullable<[DplBaseUpdateStrategy](#dplbaseupdatestrategy)> | False | - | - ## PodImagePullSecret #### Parent types: - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -name | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | False | - | - ## RoleSubject #### Parent types: - [ClusterRoleBinding](#clusterrolebinding) @@ -1080,11 +1052,11 @@ name | Identifier | False | False | - - [RoleBindingBase](#rolebindingbase) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -kind | CaseIdentifier | False | False | - -name | String | False | False | - -ns | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +kind | CaseIdentifier | False | - | - +name | String | False | - | - +ns | Nullable<Identifier> | False | - | - ## SecurityContextConstraints #### Metadata ``` @@ -1093,28 +1065,28 @@ ns | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | False | - -allowHostDirVolumePlugin | Boolean | False | False | - -allowHostIPC | Boolean | False | False | - -allowHostNetwork | Boolean | False | False | - -allowHostPID | Boolean | False | False | - -allowHostPorts | Boolean | False | False | - -allowPrivilegedContainer | Boolean | False | False | - -allowedCapabilities | Nullable> | False | False | - -defaultAddCapabilities | Nullable> | False | False | - -fsGroup | Nullable | False | False | - -groups | List | False | False | - -priority | Nullable> | False | False | - -readOnlyRootFilesystem | Boolean | False | False | - -requiredDropCapabilities | Nullable> | False | False | - -runAsUser | Nullable | False | False | - -seLinuxContext | Nullable | False | False | - -seccompProfiles | Nullable> | False | False | - -supplementalGroups | Nullable | False | False | - -users | List | False | False | - -volumes | List | False | False | - +allowHostDirVolumePlugin | Boolean | False | - | - +allowHostIPC | Boolean | False | - | - +allowHostNetwork | Boolean | False | - | - +allowHostPID | Boolean | False | - | - +allowHostPorts | Boolean | False | - | - +allowPrivilegedContainer | Boolean | False | - | - +allowedCapabilities | Nullable<List<String>> | False | - | - +defaultAddCapabilities | Nullable<List<String>> | False | - | - +fsGroup | Nullable<[SCCGroups](#sccgroups)> | False | - | - +groups | List<SystemIdentifier> | False | - | - +priority | Nullable<Positive<Integer>> | False | - | - +readOnlyRootFilesystem | Boolean | False | - | - +requiredDropCapabilities | Nullable<List<String>> | False | - | - +runAsUser | Nullable<[SCCRunAsUser](#sccrunasuser)> | False | - | - +seLinuxContext | Nullable<[SCCSELinux](#sccselinux)> | False | - | - +seccompProfiles | Nullable<List<String>> | False | - | - +supplementalGroups | Nullable<[SCCGroups](#sccgroups)> | False | - | - +users | List<SystemIdentifier> | False | - | - +volumes | List<Enum('configMap', 'downwardAPI', 'emptyDir', 'hostPath', 'nfs', 'persistentVolumeClaim', 'secret', '*')> | False | - | - ## Route #### Metadata ``` @@ -1123,14 +1095,14 @@ volumes | List | False | False | - -to | NonEmpty> | False | False | - -wildcardPolicy | Enum(u'Subdomain', u'None') | False | False | - +host | Domain | False | - | - +port | [RouteDestPort](#routedestport) | False | - | - +tls | Nullable<[RouteTLS](#routetls)> | False | - | - +to | NonEmpty<List<[RouteDest](#routedest)>> | False | - | - +wildcardPolicy | Enum('Subdomain', 'None') | False | - | - ## ContainerResourceSpec #### Parent types: - [ContainerSpec](#containerspec) @@ -1140,10 +1112,10 @@ wildcardPolicy | Enum(u'Subdomain', u'None') | False | False | - - [DCRollingStrategy](#dcrollingstrategy) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -limits | ContainerResourceEachSpec | False | False | - -requests | ContainerResourceEachSpec | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +limits | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - +requests | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - ## PolicyBindingRoleBinding #### Parents: - [RoleBindingXF](#rolebindingxf) @@ -1151,22 +1123,22 @@ requests | ContainerResourceEachSpec | False | False | - - [PolicyBinding](#policybinding) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -metadata | Nullable> | False | False | - -name | SystemIdentifier | False | False | - -ns | Identifier | False | False | - -roleRef | RoleRef | False | True | - -subjects | NonEmpty> | False | True | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +metadata | Nullable<Map<String, String>> | False | - | - +name | SystemIdentifier | False | - | - +ns | Identifier | False | - | - +roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - +subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## LifeCycle #### Parent types: - [ContainerSpec](#containerspec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -postStart | Nullable | False | False | - -preStop | Nullable | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +postStart | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - +preStop | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - ## RoleBinding #### Parents: - [RoleBindingBase](#rolebindingbase) @@ -1178,11 +1150,11 @@ preStop | Nullable | False | False | - ``` #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- name | SystemIdentifier | True | False | - -roleRef | RoleRef | False | True | - -subjects | NonEmpty> | False | True | - +roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - +subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## MatchLabelsSelector #### Parents: - [BaseSelector](#baseselector) @@ -1193,9 +1165,9 @@ subjects | NonEmpty> | False | True | - - [PersistentVolumeClaim](#persistentvolumeclaim) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -matchLabels | Map | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +matchLabels | Map<String, String> | False | - | - ## PolicyRule #### Parent types: - [ClusterRole](#clusterrole) @@ -1203,14 +1175,14 @@ matchLabels | Map | False | False | - - [RoleBase](#rolebase) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -apiGroups | NonEmpty> | False | False | - -attributeRestrictions | Nullable | False | False | - -nonResourceURLs | Nullable> | False | False | - -resourceNames | Nullable> | False | False | - -resources | NonEmpty>> | False | False | - -verbs | NonEmpty> | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +apiGroups | NonEmpty<List<String>> | False | - | - +attributeRestrictions | Nullable<String> | False | - | - +nonResourceURLs | Nullable<List<String>> | False | - | - +resourceNames | Nullable<List<String>> | False | - | - +resources | NonEmpty<List<NonEmpty<String>>> | False | - | - +verbs | NonEmpty<List<Enum('get', 'list', 'create', 'update', 'delete', 'deletecollection', 'watch')>> | False | - | - ## ContainerEnvContainerResourceSpec #### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -1220,12 +1192,12 @@ verbs | NonEmpty | False | False | - -divisor | Nullable> | False | False | - -name | EnvString | False | False | - -resource | Enum(u'limits.cpu', u'limits.memory', u'requests.cpu', u'requests.memory') | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +containerName | Nullable<Identifier> | False | - | - +divisor | Nullable<NonEmpty<String>> | False | - | - +name | EnvString | False | - | - +resource | Enum('limits.cpu', 'limits.memory', 'requests.cpu', 'requests.memory') | False | - | - ## PodVolumeSecretSpec #### Parents: - [PodVolumeItemMapper](#podvolumeitemmapper) @@ -1234,9 +1206,9 @@ resource | Enum(u'limits.cpu', u'limits.memory', u'requests.cpu', u'requests.mem - [PodTemplateSpec](#podtemplatespec) #### Properties: -Name | Type | Identifier | Abstract | Mapping ----- | ---- | ---------- | -------- | ------- -defaultMode | Nullable> | False | False | - -item_map | Nullable> | False | False | - -name | Identifier | False | False | - -secret_name | Identifier | False | False | - +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +defaultMode | Nullable<Positive<Integer>> | False | - | - +item_map | Nullable<Map<String, String>> | False | - | - +name | Identifier | False | - | - +secret_name | Identifier | False | - | - diff --git a/lib/kube_help.py b/lib/kube_help.py index a65baa7..d8a1a7d 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -7,6 +7,14 @@ from kube_types import Map, String +import sys + +import kube_obj +if sys.version_info[0] == 2: + import kube_objs +else: + import kube_objs.__init__ + # Object used to collect class definition and implement the rendering functions class KubeHelper(object): @@ -82,28 +90,37 @@ def render_markdown(self): # Parents if len(self._class_superclasses) != 0: - txt += '#### Parents: {}\n'.format(', '.join(self._get_markdown_link(self._class_superclasses))) + txt += '#### Parents: \n' + for obj in self._get_markdown_link(self._class_superclasses): + txt += '- {}\n'.format(obj) # Children if len(self._class_subclasses) != 0: - txt += '#### Children: {}\n'.format(', '.join(self._get_markdown_link(self._class_subclasses))) + txt += '#### Children: \n' + for obj in self._get_markdown_link(self._class_subclasses): + txt += '- {}\n'.format(obj) # Parent types if len(self._class_parent_types) != 0: - txt += '#### Parent types: {}\n'.format(', '.join(sorted(self._get_markdown_link(self._class_parent_types.keys())))) + txt += '#### Parent types: \n' + for obj in self._get_markdown_link(sorted(self._class_parent_types.keys())): + txt += '- {}\n'.format(obj) # Metadata if self._class_has_metadata: + txt += '#### Metadata\n' txt += '```\n' - txt += ' metadata:\n' txt += ' annotations: {}\n'.format(Map(String, String).name()) txt += ' labels: {}\n'.format(Map(String, String).name()) txt += '```\n' # Properties table + if len(self._class_types.keys()) == 0: + return txt + txt += '#### Properties:\n\n' - txt += 'Name | Type | Identifier | Abstract | Mapping\n' - txt += '---- | ---- | ---------- | -------- | -------\n' + txt += 'Name | Type | Identifier | Type Transformation | Aliases\n' + txt += '---- | ---- | ---------- | ------------------- | -------\n' if self._class_identifier is not None: txt += '{} | {} | True | False | - \n'.format(self._class_identifier, self._class_types[self._class_identifier].name()) @@ -111,12 +128,26 @@ def render_markdown(self): if p == self._class_identifier: continue - is_abstract = True if 'xf_{}'.format(p) in self._class_xf_hasattr else False + xf_data = '-' + if p in self._class_xf_detail: + xf_data = self._class_xf_detail[p] + xf_data = xf_data.replace('<', '<').replace('>', '>') + is_mapped = ', '.join(self._get_markdown_link(self._class_mapping[p])) if p in self._class_mapping else '-' - print(self._class_types[p]) + original_type = self._class_types[p].original_type() - txt += '{} | {} | False | {} | {} \n'.format(p, self._class_types[p].name(), is_abstract, is_mapped) + display_type = self._class_types[p].name().replace('<', '<').replace('>', '>') + if original_type is not None: + if isinstance(original_type, list): + original_type = original_type[0] + elif isinstance(original_type, dict): + original_type = original_type['value'] + classname = original_type.__name__ + display_type = display_type.replace(classname, '[{}](#{})'.format(classname, classname.lower())) + + + txt += '{} | {} | False | {} | {} \n'.format(p, display_type, xf_data, is_mapped) return txt \ No newline at end of file diff --git a/lib/kube_obj.py b/lib/kube_obj.py index e2df21a..6b4c123 100644 --- a/lib/kube_obj.py +++ b/lib/kube_obj.py @@ -344,7 +344,12 @@ def _rec_superclasses(kls): ret_help._class_parent_types = cls._parent_types ret_help._class_has_metadata = cls.has_metadata - ret_help._class_xf_hasattr = ['xf_{}'.format(p) for p in sorted(ret_help._class_types.keys()) if hasattr(cls, 'xf_{}'.format(p))] + ret_help._class_xf_detail = {} + for p in ret_help._class_types: + if hasattr(cls, 'xf_' + p): + ret_help._class_xf_detail[p] = '' + if hasattr(getattr(cls, 'xf_' + p), '__doc__') and getattr(cls, 'xf_' + p).__doc__ is not None and len(getattr(cls, 'xf_' + p).__doc__): + ret_help._class_xf_detail[p] = getattr(cls, 'xf_' + p).__doc__ return ret_help diff --git a/lib/kube_types.py b/lib/kube_types.py index b2e04e2..74272a9 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -126,7 +126,12 @@ def __init__(self, *args): self.enums = args def name(self): - return '{}({})'.format(self.__class__.__name__, ', '.join(map(repr, self.enums))) + def fake_repr(x): + ret = repr(x) + if ret.startswith("u'"): + return ret[1:] + return ret + return '{}({})'.format(self.__class__.__name__, ', '.join(map(fake_repr, self.enums))) def do_check(self, value, path): return value in self.enums From 763efce5afef5c3a81258312cd9b7a595e39e7b9 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 5 Jul 2018 15:11:40 +0200 Subject: [PATCH 09/40] Full test on deployment object --- docs/rubiks.class.md | 10 +++++++++- lib/kube_objs/deployment.py | 8 ++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index d417b77..64163d9 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -1017,7 +1017,15 @@ selector | Nullable<Map<String, String>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | False | - | - -## Deployment +## [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) + + + A Deployment controller provides declarative updates for Pods and ReplicaSets. + + You describe a desired state in a Deployment object, and the Deployment controller changes the actual state to the desired state at a controlled rate. + You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments. + +--- #### Metadata ``` annotations: Map diff --git a/lib/kube_objs/deployment.py b/lib/kube_objs/deployment.py index 0f26c44..f954c43 100644 --- a/lib/kube_objs/deployment.py +++ b/lib/kube_objs/deployment.py @@ -87,9 +87,17 @@ def render(self): class Deployment(KubeObj): + """ + A Deployment controller provides declarative updates for Pods and ReplicaSets. + + You describe a desired state in a Deployment object, and the Deployment controller changes the actual state to the desired state at a controlled rate. + You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments. + """ + apiVersion = 'extensions/v1beta1' kind = 'Deployment' kubectltype = 'deployment' + _document_url = 'https://kubernetes.io/docs/concepts/workloads/controllers/deployment/' _defaults = { 'minReadySeconds': None, From 3361e40cefc2deb06cad4456d608b453552157bd Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Fri, 6 Jul 2018 16:43:50 +0200 Subject: [PATCH 10/40] New display --- docs/rubiks.class.md | 289 +++++++++++++++++++++---------------------- lib/kube_help.py | 38 +++--- 2 files changed, 162 insertions(+), 165 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 64163d9..c8bf457 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -2,15 +2,15 @@ #### Parents: - [Secret](#secret) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - secrets | Map<String, String> | False | - | - tls_cert | String | False | - | - tls_key | String | False | - | - @@ -20,15 +20,15 @@ type | NonEmpty<String> | False | - | - - [ClusterIPService](#clusteripservice) - [AWSLoadBalancerService](#awsloadbalancerservice) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - @@ -36,15 +36,15 @@ sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - #### Parents: - [Secret](#secret) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - dockers | Map<String, Map<String, String>> | False | - | - secrets | Map<String, String> | False | - | - type | NonEmpty<String> | False | - | - @@ -58,27 +58,27 @@ type | NonEmpty<String> | False | - | - #### Parents: - [RoleBase](#rolebase) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ## Group #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - users | NonEmpty<List<UserIdentifier>> | False | - | - ## RouteTLS #### Parent types: @@ -106,15 +106,15 @@ uidRangeMax | Nullable<Positive<NonZero<Integer>>> | False | - uidRangeMin | Nullable<Positive<NonZero<Integer>>> | False | - | - ## PersistentVolumeClaim #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - request | Memory | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | - | - @@ -152,26 +152,26 @@ supplementalGroups | Nullable<List<Integer>> | False | - | - #### Parents: - [Namespace](#namespace) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - ## PersistentVolume #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - awsElasticBlockStore | Nullable<[AWSElasticBlockStore](#awselasticblockstore)> | False | - | - capacity | Memory | False | - | - @@ -179,15 +179,15 @@ claimRef | Nullable<[PersistentVolumeRef](#persistentvolumeref)> | False | persistentVolumeReclaimPolicy | Nullable<Enum('Retain', 'Recycle', 'Delete')> | False | - | - ## DeploymentConfig #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - paused | Nullable<Boolean> | False | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - @@ -256,15 +256,15 @@ name | Identifier | False | - | - #### Parents: - [SelectorsPreProcessMixin](#selectorspreprocessmixin) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | <unknown transformation> | - ## DCBaseUpdateStrategy @@ -286,15 +286,15 @@ resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | Fa #### Children: - [Project](#project) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - ## ContainerEnvSpec #### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -349,30 +349,30 @@ user | Nullable<String> | False | - | - - [RoleBindingBase](#rolebindingbase) - [RoleBindingXF](#rolebindingxf) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## AWSLoadBalancerService #### Parents: - [Service](#service) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - aws-load-balancer-backend-protocol | Nullable<Identifier> | False | - | - aws-load-balancer-ssl-cert | Nullable<ARN> | False | - | - externalTrafficPolicy | Nullable<Enum('Cluster', 'Local')> | False | - | - @@ -381,15 +381,15 @@ selector | NonEmpty<Map<String, String>> | False | <unknown trans sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ## Job #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - activeDeadlineSeconds | Nullable<Positive<Integer>> | False | - | - completions | Nullable<Positive<NonZero<Integer>>> | False | - | - manualSelector | Nullable<Boolean> | False | - | - @@ -442,7 +442,7 @@ maxUnavailable | SurgeSpec | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - args | Nullable<List<String>> | False | - | - command | Nullable<List<String>> | False | - | - env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - @@ -522,27 +522,27 @@ Name | Type | Identifier | Type Transformation | Aliases name | Identifier | False | - | - ## PolicyBinding #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | ColonIdentifier | True | False | - +name | ColonIdentifier | True | - | - roleBindings | List<[PolicyBindingRoleBinding](#policybindingrolebinding)> | False | <unknown transformation> | - ## ConfigMap #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - files | Map<String, String> | False | - | - ## SCCGroups #### Parent types: @@ -578,15 +578,15 @@ cpu | Nullable<Positive<NonZero<Number>>> | False | <unknow memory | Nullable<Memory> | False | - | - ## StorageClass #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - parameters | Map<String, String> | False | - | - provisioner | String | False | - | - ## DCRollingParams @@ -661,10 +661,10 @@ ns | Nullable<Identifier> | False | - | - - [Job](#job) - [ReplicationController](#replicationcontroller) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -684,15 +684,15 @@ terminationGracePeriodSeconds | Nullable<Positive<Integer>> | False volumes | Nullable<List<[PodVolumeBaseSpec](#podvolumebasespec)>> | False | - | - ## User #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | UserIdentifier | True | False | - +name | UserIdentifier | True | - | - fullName | Nullable<String> | False | - | - identities | NonEmpty<List<NonEmpty<String>>> | False | - | - ## ContainerEnvConfigMapSpec @@ -760,15 +760,15 @@ fieldPath | Enum('metadata.name', 'metadata.namespace', 'metadata.labels', 'meta name | EnvString | False | - | - ## ServiceAccount #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - imagePullSecrets | Nullable<List<[SAImgPullSecretSubject](#saimgpullsecretsubject)>> | False | <unknown transformation> | - secrets | Nullable<List<[SASecretSubject](#sasecretsubject)>> | False | <unknown transformation> | - ## PodVolumeBaseSpec @@ -790,15 +790,15 @@ name | Identifier | False | - | - #### Parents: - [RoleBase](#rolebase) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ## DCLifecycleHook #### Parent types: @@ -815,15 +815,15 @@ tagImages | Nullable<[DCTagImages](#dctagimages)> | False | - | - #### Parents: - [Service](#service) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - clusterIP | Nullable<IPv4> | False | - | - ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - @@ -926,15 +926,15 @@ toUid | Nullable<String> | False | - | - - [DockerCredentials](#dockercredentials) - [TLSCredentials](#tlscredentials) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - secrets | Map<String, String> | False | - | - type | NonEmpty<String> | False | - | - ## RouteDestPort @@ -996,15 +996,15 @@ fsType | Enum('ext4') | False | - | - volumeID | AWSVolID | False | - | - ## ReplicationController #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - replicas | Positive<NonZero<Integer>> | False | - | - @@ -1020,22 +1020,21 @@ name | Identifier | False | - | - ## [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) - A Deployment controller provides declarative updates for Pods and ReplicaSets. +A Deployment controller provides declarative updates for Pods and ReplicaSets. + +You describe a desired state in a Deployment object, and the Deployment controller changes the actual state to the desired state at a controlled rate. +You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments. - You describe a desired state in a Deployment object, and the Deployment controller changes the actual state to the desired state at a controlled rate. - You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments. - ---- #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - paused | Nullable<Boolean> | False | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - @@ -1067,15 +1066,15 @@ name | String | False | - | - ns | Nullable<Identifier> | False | - | - ## SecurityContextConstraints #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - allowHostDirVolumePlugin | Boolean | False | - | - allowHostIPC | Boolean | False | - | - allowHostNetwork | Boolean | False | - | - @@ -1097,15 +1096,15 @@ users | List<SystemIdentifier> | False | - | - volumes | List<Enum('configMap', 'downwardAPI', 'emptyDir', 'hostPath', 'nfs', 'persistentVolumeClaim', 'secret', '*')> | False | - | - ## Route #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | False | - +name | Identifier | True | - | - host | Domain | False | - | - port | [RouteDestPort](#routedestport) | False | - | - tls | Nullable<[RouteTLS](#routetls)> | False | - | - @@ -1152,15 +1151,15 @@ preStop | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - - [RoleBindingBase](#rolebindingbase) - [RoleBindingXF](#rolebindingxf) #### Metadata -``` - annotations: Map - labels: Map -``` +Name | Format +---- | ------ +annotations | Map +labels | Map #### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | SystemIdentifier | True | False | - +name | SystemIdentifier | True | - | - roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## MatchLabelsSelector diff --git a/lib/kube_help.py b/lib/kube_help.py index d8a1a7d..be2d85a 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -7,14 +7,6 @@ from kube_types import Map, String -import sys - -import kube_obj -if sys.version_info[0] == 2: - import kube_objs -else: - import kube_objs.__init__ - # Object used to collect class definition and implement the rendering functions class KubeHelper(object): @@ -30,6 +22,7 @@ class KubeHelper(object): _class_doc = None _class_doc_link = None _class_xf_hasattr = [] + _class_xf_detail = [] def __init__(self, *args, **kwargs): if 'name' in kwargs: @@ -75,7 +68,13 @@ def render_terminal(self): def _get_markdown_link(self, objects): - return ['[{}](#{})'.format(classname, classname.lower()) for classname in objects] + if isinstance(objects, list): + return ['[{}](#{})'.format(classname, classname.lower()) for classname in objects] + else: + return '[{}](#{})'.format(objects, objects.lower()) + + def _docstring_formatter(self): + return '\n'.join([line.strip() for line in self._class_doc.split('\n')]) def render_markdown(self): # Title generation based on link @@ -86,7 +85,7 @@ def render_markdown(self): # Add class doc string if exists if self._class_doc is not None: - txt += '\n{}\n---\n'.format(self._class_doc) + txt += '\n{}\n'.format(self._docstring_formatter()) # Parents if len(self._class_superclasses) != 0: @@ -109,10 +108,10 @@ def render_markdown(self): # Metadata if self._class_has_metadata: txt += '#### Metadata\n' - txt += '```\n' - txt += ' annotations: {}\n'.format(Map(String, String).name()) - txt += ' labels: {}\n'.format(Map(String, String).name()) - txt += '```\n' + txt += 'Name | Format\n' + txt += '---- | ------\n' + txt += 'annotations | {}\n'.format(Map(String, String).name()) + txt += 'labels | {}\n'.format(Map(String, String).name()) # Properties table if len(self._class_types.keys()) == 0: @@ -122,29 +121,28 @@ def render_markdown(self): txt += 'Name | Type | Identifier | Type Transformation | Aliases\n' txt += '---- | ---- | ---------- | ------------------- | -------\n' if self._class_identifier is not None: - txt += '{} | {} | True | False | - \n'.format(self._class_identifier, self._class_types[self._class_identifier].name()) + txt += '{} | {} | True | - | - \n'.format(self._class_identifier, self._class_types[self._class_identifier].name()) for p in sorted(self._class_types.keys()): if p == self._class_identifier: continue - xf_data = '-' - if p in self._class_xf_detail: - xf_data = self._class_xf_detail[p] + # Prepare Type transformation and remove special character that could ruin visualization in markdown + xf_data = self._class_xf_detail[p] if p in self._class_xf_detail else '-' xf_data = xf_data.replace('<', '<').replace('>', '>') is_mapped = ', '.join(self._get_markdown_link(self._class_mapping[p])) if p in self._class_mapping else '-' original_type = self._class_types[p].original_type() - display_type = self._class_types[p].name().replace('<', '<').replace('>', '>') + if original_type is not None: if isinstance(original_type, list): original_type = original_type[0] elif isinstance(original_type, dict): original_type = original_type['value'] classname = original_type.__name__ - display_type = display_type.replace(classname, '[{}](#{})'.format(classname, classname.lower())) + display_type = display_type.replace(classname, self._get_markdown_link(classname)) txt += '{} | {} | False | {} | {} \n'.format(p, display_type, xf_data, is_mapped) From cf4b92e6ef5f8503c7378638c2f765c8652238d3 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 13:56:25 +0200 Subject: [PATCH 11/40] Changed attributes management inside KubeHelper --- lib/kube_help.py | 154 ++++++++++++++++++++++++++++++----------------- lib/kube_obj.py | 30 ++++----- 2 files changed, 113 insertions(+), 71 deletions(-) diff --git a/lib/kube_help.py b/lib/kube_help.py index be2d85a..72cc4aa 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -10,59 +10,101 @@ # Object used to collect class definition and implement the rendering functions class KubeHelper(object): - _class_name = None - _class_subclasses = [] - _class_superclasses = None - _class_types = {} - _class_is_abstract = None - _class_identifier = None - _class_mapping = [] - _class_parent_types = None - _class_has_metadata = None - _class_doc = None - _class_doc_link = None - _class_xf_hasattr = [] - _class_xf_detail = [] + # Internal data structure to store needed data + _data = {} + # List of all needed field to have + _defaults = { + 'class_name': None, + 'class_subclasses': [], + 'class_superclasses': None, + 'class_types': {}, + 'class_is_abstract': None, + 'class_identifier': None, + 'class_mapping': [], + 'class_parent_types': None, + 'class_has_metadata': None, + 'class_doc': None, + 'class_doc_link': None, + 'class_xf_hasattr': [], + 'class_xf_detail': [] + } + # definition of mandatory field to display + _mandatory = { + 'class_name': True, + 'class_subclasses': False, + 'class_superclasses': False, + 'class_types': False, + 'class_is_abstract': True, + 'class_identifier': False, + 'class_mapping': False, + 'class_parent_types': False, + 'class_has_metadata': True, + 'class_doc': False, + 'class_doc_link': False, + 'class_xf_hasattr': False, + 'class_xf_detail': False + } def __init__(self, *args, **kwargs): + self._defaults_creations() + if 'name' in kwargs: - self._class_name = kwargs['name'] + self.class_name = kwargs['name'] if 'document' in kwargs: - self._class_doc = kwargs['document'] + self.class_doc = kwargs['document'] if 'documentlink' in kwargs: - self._class_doc_link = kwargs['documentlink'] + self.class_doc_link = kwargs['documentlink'] + + def _defaults_creations(self): + for name in getattr(self, '_defaults'): + if name in self._mandatory: + self._data[name] = self._defaults[name] + else: + raise Exception('Missing mandatory information for {} inside {} class'.format(name, self.__class__.__name__)) + + def __getattr__(self, name): + if name in getattr(self, '_data'): + return self._data[name] + else: + raise ValueError + + def __setattr__(self, name, value): + if name in getattr(self, '_data'): + self._data[name] = value + else: + raise ValueError def render_terminal(self): - txt = '{}{}:\n'.format(self._class_name, self._class_is_abstract) - - if len(self._class_superclasses) != 0: - txt += ' parents: {}\n'.format(', '.join(self._class_superclasses)) - if len(self._class_subclasses) != 0: - txt += ' children: {}\n'.format(', '.join(self._class_subclasses)) - if len(self._class_parent_types) != 0: - txt += ' parent types: {}\n'.format(', '.join(sorted(self._class_parent_types.keys()))) - if self._class_has_metadata: + txt = '{}{}:\n'.format(self.class_name, self.class_is_abstract) + + if len(self.class_superclasses) != 0: + txt += ' parents: {}\n'.format(', '.join(self.class_superclasses)) + if len(self.class_subclasses) != 0: + txt += ' children: {}\n'.format(', '.join(self.class_subclasses)) + if len(self.class_parent_types) != 0: + txt += ' parent types: {}\n'.format(', '.join(sorted(self.class_parent_types.keys()))) + if self.class_has_metadata: txt += ' metadata:\n' txt += ' annotations: {}\n'.format(Map(String, String).name()) txt += ' labels: {}\n'.format(Map(String, String).name()) txt += ' properties:\n' - if self._class_identifier is not None: + if self.class_identifier is not None: spc = '' - if len(self._class_identifier) < 7: - spc = (7 - len(self._class_identifier)) * ' ' - txt += ' {} (identifier): {}{}\n'.format(self._class_identifier, spc, self._class_types[self._class_identifier].name()) + if len(self.class_identifier) < 7: + spc = (7 - len(self.class_identifier)) * ' ' + txt += ' {} (identifier): {}{}\n'.format(self.class_identifier, spc, self.class_types[self.class_identifier].name()) - for p in sorted(self._class_types.keys()): - if p == self._class_identifier: + for p in sorted(self.class_types.keys()): + if p == self.class_identifier: continue spc = '' if len(p) < 20: spc = (20 - len(p)) * ' ' - xf = '*' if 'xf_{}'.format(p) in self._class_xf_hasattr else ' ' + xf = '*' if 'xf_{}'.format(p) in self.class_xf_hasattr else ' ' - txt += ' {}{}: {}{}\n'.format(xf, p, spc, self._class_types[p].name()) - if p in self._class_mapping: - txt += ' ({})\n'.format(', '.join(self._class_mapping[p])) + txt += ' {}{}: {}{}\n'.format(xf, p, spc, self.class_types[p].name()) + if p in self.class_mapping: + txt += ' ({})\n'.format(', '.join(self.class_mapping[p])) return txt @@ -74,39 +116,39 @@ def _get_markdown_link(self, objects): return '[{}](#{})'.format(objects, objects.lower()) def _docstring_formatter(self): - return '\n'.join([line.strip() for line in self._class_doc.split('\n')]) + return '\n'.join([line.strip() for line in self.class_doc.split('\n')]) def render_markdown(self): # Title generation based on link - if self._class_doc_link is not None: - txt = '## [{}]({})\n'.format(self._class_name, self._class_doc_link) + if self.class_doc_link is not None: + txt = '## [{}]({})\n'.format(self.class_name, self.class_doc_link) else: - txt = '## {}\n'.format(self._class_name) + txt = '## {}\n'.format(self.class_name) # Add class doc string if exists - if self._class_doc is not None: + if self.class_doc is not None: txt += '\n{}\n'.format(self._docstring_formatter()) # Parents - if len(self._class_superclasses) != 0: + if len(self.class_superclasses) != 0: txt += '#### Parents: \n' - for obj in self._get_markdown_link(self._class_superclasses): + for obj in self._get_markdown_link(self.class_superclasses): txt += '- {}\n'.format(obj) # Children - if len(self._class_subclasses) != 0: + if len(self.class_subclasses) != 0: txt += '#### Children: \n' - for obj in self._get_markdown_link(self._class_subclasses): + for obj in self._get_markdown_link(self.class_subclasses): txt += '- {}\n'.format(obj) # Parent types - if len(self._class_parent_types) != 0: + if len(self.class_parent_types) != 0: txt += '#### Parent types: \n' - for obj in self._get_markdown_link(sorted(self._class_parent_types.keys())): + for obj in self._get_markdown_link(sorted(self.class_parent_types.keys())): txt += '- {}\n'.format(obj) # Metadata - if self._class_has_metadata: + if self.class_has_metadata: txt += '#### Metadata\n' txt += 'Name | Format\n' txt += '---- | ------\n' @@ -114,27 +156,27 @@ def render_markdown(self): txt += 'labels | {}\n'.format(Map(String, String).name()) # Properties table - if len(self._class_types.keys()) == 0: + if len(self.class_types.keys()) == 0: return txt txt += '#### Properties:\n\n' txt += 'Name | Type | Identifier | Type Transformation | Aliases\n' txt += '---- | ---- | ---------- | ------------------- | -------\n' - if self._class_identifier is not None: - txt += '{} | {} | True | - | - \n'.format(self._class_identifier, self._class_types[self._class_identifier].name()) + if self.class_identifier is not None: + txt += '{} | {} | True | - | - \n'.format(self.class_identifier, self.class_types[self.class_identifier].name()) - for p in sorted(self._class_types.keys()): - if p == self._class_identifier: + for p in sorted(self.class_types.keys()): + if p == self.class_identifier: continue # Prepare Type transformation and remove special character that could ruin visualization in markdown - xf_data = self._class_xf_detail[p] if p in self._class_xf_detail else '-' + xf_data = self.class_xf_detail[p] if p in self.class_xf_detail else '-' xf_data = xf_data.replace('<', '<').replace('>', '>') - is_mapped = ', '.join(self._get_markdown_link(self._class_mapping[p])) if p in self._class_mapping else '-' + is_mapped = ', '.join(self._get_markdown_link(self.class_mapping[p])) if p in self.class_mapping else '-' - original_type = self._class_types[p].original_type() - display_type = self._class_types[p].name().replace('<', '<').replace('>', '>') + original_type = self.class_types[p].original_type() + display_type = self.class_types[p].name().replace('<', '<').replace('>', '>') if original_type is not None: if isinstance(original_type, list): diff --git a/lib/kube_obj.py b/lib/kube_obj.py index 6b4c123..cb6b72e 100644 --- a/lib/kube_obj.py +++ b/lib/kube_obj.py @@ -326,30 +326,30 @@ def _rec_superclasses(kls): return ret - ret_help._class_subclasses = list(map(lambda x: x.__name__, cls.get_subclasses(non_abstract=False, include_self=False))) - ret_help._class_superclasses = list(map(lambda x: x.__name__, _rec_superclasses(cls))) + ret_help.class_subclasses = list(map(lambda x: x.__name__, cls.get_subclasses(non_abstract=False, include_self=False))) + ret_help.class_superclasses = list(map(lambda x: x.__name__, _rec_superclasses(cls))) - ret_help._class_types = cls.resolve_types() + ret_help.class_types = cls.resolve_types() - ret_help._class_is_abstract = '' if cls.is_abstract_type() else ' (abstract type)' - ret_help._class_identifier = cls.identifier if hasattr(cls, 'identifier') and cls.identifier is not None else None + ret_help.class_is_abstract = '' if cls.is_abstract_type() else ' (abstract type)' + ret_help.class_identifier = cls.identifier if hasattr(cls, 'identifier') and cls.identifier is not None else None mapping = cls._find_defaults('_map') - ret_help._class_mapping = {} + ret_help.class_mapping = {} for d in mapping: - if mapping[d] not in ret_help._class_mapping: - ret_help._class_mapping[mapping[d]] = [] - ret_help._class_mapping[mapping[d]].append(d) + if mapping[d] not in ret_help.class_mapping: + ret_help.class_mapping[mapping[d]] = [] + ret_help.class_mapping[mapping[d]].append(d) - ret_help._class_parent_types = cls._parent_types - ret_help._class_has_metadata = cls.has_metadata + ret_help.class_parent_types = cls._parent_types + ret_help.class_has_metadata = cls.has_metadata - ret_help._class_xf_detail = {} - for p in ret_help._class_types: + ret_help.class_xf_detail = {} + for p in ret_help.class_types: if hasattr(cls, 'xf_' + p): - ret_help._class_xf_detail[p] = '' + ret_help.class_xf_detail[p] = '' if hasattr(getattr(cls, 'xf_' + p), '__doc__') and getattr(cls, 'xf_' + p).__doc__ is not None and len(getattr(cls, 'xf_' + p).__doc__): - ret_help._class_xf_detail[p] = getattr(cls, 'xf_' + p).__doc__ + ret_help.class_xf_detail[p] = getattr(cls, 'xf_' + p).__doc__ return ret_help From 53ea0cbbb4bac3f502016524ac8928a3eb32ef6a Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 13:58:36 +0200 Subject: [PATCH 12/40] Updated gitignore --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 7344fb0..a5c180f 100644 --- a/.gitignore +++ b/.gitignore @@ -7,3 +7,6 @@ __pycache__ # yaml build directory build + +# Visual Studio Code +.vscode/ From 8d76e1a3def52a0674d34e1ef92cf8a3c2839c6d Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 14:12:18 +0200 Subject: [PATCH 13/40] Added table of content --- docs/rubiks.class.md | 103 +++++++++++++++++++++++++++++++++++++++++ lib/commands/docgen.py | 12 +++++ 2 files changed, 115 insertions(+) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index c8bf457..0c72ebf 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -1,3 +1,106 @@ +# Rubiks Object Index + +This document is automatically generated using the command `docgen` and describe all the object and types that can be used inside Rubiks to configure your cluster + + +# Table of contents + +- [Objects](#objects) + - [TLSCredentials](#tlscredentials) + - [Service](#service) + - [DockerCredentials](#dockercredentials) + - [DplBaseUpdateStrategy](#dplbaseupdatestrategy) + - [Role](#role) + - [Group](#group) + - [RouteTLS](#routetls) + - [SCCRunAsUser](#sccrunasuser) + - [PersistentVolumeClaim](#persistentvolumeclaim) + - [PodVolumePVCSpec](#podvolumepvcspec) + - [DCConfigChangeTrigger](#dcconfigchangetrigger) + - [SecurityContext](#securitycontext) + - [Project](#project) + - [PersistentVolume](#persistentvolume) + - [DeploymentConfig](#deploymentconfig) + - [ContainerPort](#containerport) + - [DCImageChangeTrigger](#dcimagechangetrigger) + - [RoleRef](#roleref) + - [LifeCycleHTTP](#lifecyclehttp) + - [PodVolumeItemMapper](#podvolumeitemmapper) + - [DaemonSet](#daemonset) + - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) + - [Namespace](#namespace) + - [ContainerEnvSpec](#containerenvspec) + - [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) + - [MatchExpression](#matchexpression) + - [SCCSELinux](#sccselinux) + - [ClusterRoleBinding](#clusterrolebinding) + - [AWSLoadBalancerService](#awsloadbalancerservice) + - [Job](#job) + - [RouteDestService](#routedestservice) + - [DCRecreateStrategy](#dcrecreatestrategy) + - [DplRollingUpdateStrategy](#dplrollingupdatestrategy) + - [ContainerSpec](#containerspec) + - [DplRecreateStrategy](#dplrecreatestrategy) + - [DCTrigger](#dctrigger) + - [ContainerEnvSecretSpec](#containerenvsecretspec) + - [MatchExpressionsSelector](#matchexpressionsselector) + - [ContainerProbeBaseSpec](#containerprobebasespec) + - [PodVolumeEmptyDirSpec](#podvolumeemptydirspec) + - [PolicyBinding](#policybinding) + - [ConfigMap](#configmap) + - [SCCGroups](#sccgroups) + - [DCCustomStrategy](#dccustomstrategy) + - [ContainerResourceEachSpec](#containerresourceeachspec) + - [StorageClass](#storageclass) + - [DCRollingParams](#dcrollingparams) + - [SCCGroupRange](#sccgrouprange) + - [DCCustomParams](#dccustomparams) + - [ContainerVolumeMountSpec](#containervolumemountspec) + - [LifeCycleProbe](#lifecycleprobe) + - [SASecretSubject](#sasecretsubject) + - [PodTemplateSpec](#podtemplatespec) + - [User](#user) + - [ContainerEnvConfigMapSpec](#containerenvconfigmapspec) + - [LifeCycleExec](#lifecycleexec) + - [DCRollingStrategy](#dcrollingstrategy) + - [RouteDest](#routedest) + - [ContainerEnvPodFieldSpec](#containerenvpodfieldspec) + - [ServiceAccount](#serviceaccount) + - [PodVolumeBaseSpec](#podvolumebasespec) + - [ClusterRole](#clusterrole) + - [DCLifecycleHook](#dclifecyclehook) + - [ClusterIPService](#clusteripservice) + - [PersistentVolumeRef](#persistentvolumeref) + - [DCLifecycleNewPod](#dclifecyclenewpod) + - [ContainerProbeTCPPortSpec](#containerprobetcpportspec) + - [ContainerEnvBaseSpec](#containerenvbasespec) + - [PodVolumeHostSpec](#podvolumehostspec) + - [DCRecreateParams](#dcrecreateparams) + - [DCTagImages](#dctagimages) + - [Secret](#secret) + - [RouteDestPort](#routedestport) + - [BaseSelector](#baseselector) + - [ContainerProbeHTTPSpec](#containerprobehttpspec) + - [ServicePort](#serviceport) + - [AWSElasticBlockStore](#awselasticblockstore) + - [ReplicationController](#replicationcontroller) + - [SAImgPullSecretSubject](#saimgpullsecretsubject) + - [Deployment](#deployment) + - [PodImagePullSecret](#podimagepullsecret) + - [RoleSubject](#rolesubject) + - [SecurityContextConstraints](#securitycontextconstraints) + - [Route](#route) + - [ContainerResourceSpec](#containerresourcespec) + - [PolicyBindingRoleBinding](#policybindingrolebinding) + - [LifeCycle](#lifecycle) + - [RoleBinding](#rolebinding) + - [MatchLabelsSelector](#matchlabelsselector) + - [PolicyRule](#policyrule) + - [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) + - [PodVolumeSecretSpec](#podvolumesecretspec) + +# Objects + ## TLSCredentials #### Parents: - [Secret](#secret) diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index 8526680..975fe52 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -13,16 +13,28 @@ class Command_docgen(Command, CommandRepositoryBase): """Generate a markdown file with basic description for all object inside rubiks""" + _description = """ + This document is automatically generated using the command `docgen` and describe all the object and types that can be used inside Rubiks to configure your cluster + """ + def populate_args(self, parser): pass def run(self, args): objs = load_python.PythonBaseFile.get_kube_objs() r = self.get_repository() + doc = '\n'.join([line.strip() for line in self._description.split('\n')]) + md = '' + header = '# Rubiks Object Index\n{}\n\n'.format(doc) + header += '# Table of contents\n\n' + header += '- [Objects](#objects)\n' for oname in objs.keys(): + header += ' - [{}](#{})\n'.format(oname, oname.lower()) md += objs[oname].get_help().render_markdown() + header += '\n# Objects\n\n' with open(os.path.join(r.basepath, 'docs/rubiks.class.md'), 'w') as f: + f.write(header) f.write(md) \ No newline at end of file From fe0f4bb3098f457f66798fbcf6270b6f90d0f24e Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 15:21:35 +0200 Subject: [PATCH 14/40] Added types to the list --- docs/rubiks.class.md | 554 ++++++++++++++++++++++++----------------- lib/commands/docgen.py | 13 +- lib/kube_help.py | 10 +- lib/kube_types.py | 6 + lib/load_python.py | 20 +- 5 files changed, 366 insertions(+), 237 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 0c72ebf..df3b6a8 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -5,6 +5,22 @@ This document is automatically generated using the command `docgen` and describe # Table of contents +- [Types](#types) + - [ColonIdentifier](#colonidentifier) + - [Domain](#domain) + - [CaseIdentifier](#caseidentifier) + - [String](#string) + - [IP](#ip) + - [SurgeSpec](#surgespec) + - [Enum](#enum) + - [Number](#number) + - [Boolean](#boolean) + - [IPv4](#ipv4) + - [Path](#path) + - [Integer](#integer) + - [Identifier](#identifier) + - [ARN](#arn) + - [SystemIdentifier](#systemidentifier) - [Objects](#objects) - [TLSCredentials](#tlscredentials) - [Service](#service) @@ -99,17 +115,95 @@ This document is automatically generated using the command `docgen` and describe - [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) - [PodVolumeSecretSpec](#podvolumesecretspec) +# Types + +## ColonIdentifier + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Domain + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## CaseIdentifier + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## String + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## IP + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## SurgeSpec + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Enum + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Number + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Boolean + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## IPv4 + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Path + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Integer + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Identifier + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## ARN + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## SystemIdentifier + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + + # Objects ## TLSCredentials -#### Parents: +### Parents: - [Secret](#secret) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -119,15 +213,15 @@ tls_cert | String | False | - | - tls_key | String | False | - | - type | NonEmpty<String> | False | - | - ## Service -#### Children: +### Children: - [ClusterIPService](#clusteripservice) - [AWSLoadBalancerService](#awsloadbalancerservice) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -136,14 +230,14 @@ ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <un selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ## DockerCredentials -#### Parents: +### Parents: - [Secret](#secret) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -152,41 +246,41 @@ dockers | Map<String, Map<String, String>> | False | - | - secrets | Map<String, String> | False | - | - type | NonEmpty<String> | False | - | - ## DplBaseUpdateStrategy -#### Children: +### Children: - [DplRecreateStrategy](#dplrecreatestrategy) - [DplRollingUpdateStrategy](#dplrollingupdatestrategy) -#### Parent types: +### Parent types: - [Deployment](#deployment) ## Role -#### Parents: +### Parents: - [RoleBase](#rolebase) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ## Group -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - users | NonEmpty<List<UserIdentifier>> | False | - | - ## RouteTLS -#### Parent types: +### Parent types: - [Route](#route) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -197,9 +291,9 @@ insecureEdgeTerminationPolicy | Enum('Allow', 'Disable', 'Redirect') | False | - key | Nullable<NonEmpty<String>> | False | - | - termination | Enum('edge', 'reencrypt', 'passthrough') | False | - | - ## SCCRunAsUser -#### Parent types: +### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -208,12 +302,12 @@ uid | Nullable<Positive<NonZero<Integer>>> | False | - | - uidRangeMax | Nullable<Positive<NonZero<Integer>>> | False | - | - uidRangeMin | Nullable<Positive<NonZero<Integer>>> | False | - | - ## PersistentVolumeClaim -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -223,26 +317,26 @@ request | Memory | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | - | - volumeName | Nullable<Identifier> | False | <unknown transformation> | - ## PodVolumePVCSpec -#### Parents: +### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: +### Parent types: - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- claimName | Identifier | False | - | - name | Identifier | False | - | - ## DCConfigChangeTrigger -#### Parents: +### Parents: - [DCTrigger](#dctrigger) -#### Parent types: +### Parent types: - [DeploymentConfig](#deploymentconfig) ## SecurityContext -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -252,25 +346,25 @@ runAsNonRoot | Nullable<Boolean> | False | - | - runAsUser | Nullable<Integer> | False | - | - supplementalGroups | Nullable<List<Integer>> | False | - | - ## Project -#### Parents: +### Parents: - [Namespace](#namespace) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - ## PersistentVolume -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -281,12 +375,12 @@ capacity | Memory | False | - | - claimRef | Nullable<[PersistentVolumeRef](#persistentvolumeref)> | False | - | - persistentVolumeReclaimPolicy | Nullable<Enum('Retain', 'Recycle', 'Delete')> | False | - | - ## DeploymentConfig -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -301,9 +395,9 @@ strategy | [DCBaseUpdateStrategy](#dcbaseupdatestrategy) | False | - | - test | Boolean | False | - | - triggers | List<[DCTrigger](#dctrigger)> | False | - | - ## ContainerPort -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -313,28 +407,28 @@ hostPort | Nullable<Positive<NonZero<Integer>>> | False | - | name | Nullable<String> | False | - | - protocol | Enum('TCP', 'UDP') | False | - | - ## DCImageChangeTrigger -#### Parents: +### Parents: - [DCTrigger](#dctrigger) -#### Parent types: +### Parent types: - [DeploymentConfig](#deploymentconfig) ## RoleRef -#### Parent types: +### Parent types: - [ClusterRoleBinding](#clusterrolebinding) - [PolicyBindingRoleBinding](#policybindingrolebinding) - [RoleBinding](#rolebinding) - [RoleBindingBase](#rolebindingbase) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Nullable<SystemIdentifier> | False | - | - ns | Nullable<Identifier> | False | - | - ## LifeCycleHTTP -#### Parents: +### Parents: - [LifeCycleProbe](#lifecycleprobe) -#### Parent types: +### Parent types: - [LifeCycle](#lifecycle) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -342,28 +436,28 @@ path | NonEmpty<Path> | False | - | - port | Positive<NonZero<Integer>> | False | - | - scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - ## PodVolumeItemMapper -#### Parents: +### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) -#### Children: +### Children: - [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) - [PodVolumeSecretSpec](#podvolumesecretspec) -#### Parent types: +### Parent types: - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- item_map | Nullable<Map<String, String>> | False | - | - name | Identifier | False | - | - ## DaemonSet -#### Parents: +### Parents: - [SelectorsPreProcessMixin](#selectorspreprocessmixin) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -371,13 +465,13 @@ name | Identifier | True | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | <unknown transformation> | - ## DCBaseUpdateStrategy -#### Children: +### Children: - [DCRecreateStrategy](#dcrecreatestrategy) - [DCRollingStrategy](#dcrollingstrategy) - [DCCustomStrategy](#dccustomstrategy) -#### Parent types: +### Parent types: - [DeploymentConfig](#deploymentconfig) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -386,38 +480,38 @@ annotations | Map<String, String> | False | - | - labels | Map<String, String> | False | - | - resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## Namespace -#### Children: +### Children: - [Project](#project) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - ## ContainerEnvSpec -#### Parents: +### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) - [DCCustomParams](#dccustomparams) - [DCLifecycleNewPod](#dclifecyclenewpod) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | EnvString | False | - | - value | String | False | - | - ## PodVolumeConfigMapSpec -#### Parents: +### Parents: - [PodVolumeItemMapper](#podvolumeitemmapper) - [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: +### Parent types: - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -426,9 +520,9 @@ item_map | Nullable<Map<String, String>> | False | - | - map_name | Identifier | False | - | - name | Identifier | False | - | - ## MatchExpression -#### Parent types: +### Parent types: - [MatchExpressionsSelector](#matchexpressionsselector) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -436,9 +530,9 @@ key | NonEmpty<String> | False | - | - operator | Enum('In', 'NotIn', 'Exists', 'DoesNotExist') | False | - | - values | Nullable<List<String>> | False | - | - ## SCCSELinux -#### Parent types: +### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -448,15 +542,15 @@ strategy | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - type | Nullable<String> | False | - | - user | Nullable<String> | False | - | - ## ClusterRoleBinding -#### Parents: +### Parents: - [RoleBindingBase](#rolebindingbase) - [RoleBindingXF](#rolebindingxf) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -464,14 +558,14 @@ name | Identifier | True | - | - roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## AWSLoadBalancerService -#### Parents: +### Parents: - [Service](#service) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -483,12 +577,12 @@ ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <un selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ## Job -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -500,22 +594,22 @@ parallelism | Nullable<Positive<NonZero<Integer>>> | False | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | - | - ## RouteDestService -#### Parents: +### Parents: - [RouteDest](#routedest) -#### Parent types: +### Parent types: - [Route](#route) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | False | - | - weight | Positive<NonZero<Integer>> | False | - | - ## DCRecreateStrategy -#### Parents: +### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) -#### Parent types: +### Parent types: - [DeploymentConfig](#deploymentconfig) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -526,22 +620,22 @@ labels | Map<String, String> | False | - | - recreateParams | Nullable<[DCRecreateParams](#dcrecreateparams)> | False | - | - resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## DplRollingUpdateStrategy -#### Parents: +### Parents: - [DplBaseUpdateStrategy](#dplbaseupdatestrategy) -#### Parent types: +### Parent types: - [Deployment](#deployment) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- maxSurge | SurgeSpec | False | - | - maxUnavailable | SurgeSpec | False | - | - ## ContainerSpec -#### Parents: +### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) -#### Parent types: +### Parent types: - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -561,24 +655,24 @@ securityContext | Nullable<[SecurityContext](#securitycontext)> | False | terminationMessagePath | Nullable<NonEmpty<Path>> | False | - | - volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | <unknown transformation> | - ## DplRecreateStrategy -#### Parents: +### Parents: - [DplBaseUpdateStrategy](#dplbaseupdatestrategy) -#### Parent types: +### Parent types: - [Deployment](#deployment) ## DCTrigger -#### Children: +### Children: - [DCConfigChangeTrigger](#dcconfigchangetrigger) - [DCImageChangeTrigger](#dcimagechangetrigger) -#### Parent types: +### Parent types: - [DeploymentConfig](#deploymentconfig) ## ContainerEnvSecretSpec -#### Parents: +### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) - [DCCustomParams](#dccustomparams) - [DCLifecycleNewPod](#dclifecyclenewpod) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -586,25 +680,25 @@ key | NonEmpty<String> | False | - | - name | EnvString | False | - | - secret_name | Identifier | False | - | - ## MatchExpressionsSelector -#### Parents: +### Parents: - [BaseSelector](#baseselector) -#### Parent types: +### Parent types: - [DaemonSet](#daemonset) - [Deployment](#deployment) - [Job](#job) - [PersistentVolumeClaim](#persistentvolumeclaim) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- matchExpressions | NonEmpty<List<[MatchExpression](#matchexpression)>> | False | - | - ## ContainerProbeBaseSpec -#### Children: +### Children: - [ContainerProbeTCPPortSpec](#containerprobetcpportspec) - [ContainerProbeHTTPSpec](#containerprobehttpspec) -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -614,54 +708,54 @@ periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## PodVolumeEmptyDirSpec -#### Parents: +### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: +### Parent types: - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | False | - | - ## PolicyBinding -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | ColonIdentifier | True | - | - roleBindings | List<[PolicyBindingRoleBinding](#policybindingrolebinding)> | False | <unknown transformation> | - ## ConfigMap -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - files | Map<String, String> | False | - | - ## SCCGroups -#### Parent types: +### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- ranges | Nullable<List<[SCCGroupRange](#sccgrouprange)>> | False | - | - type | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - ## DCCustomStrategy -#### Parents: +### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) -#### Parent types: +### Parent types: - [DeploymentConfig](#deploymentconfig) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -671,21 +765,21 @@ customParams | [DCCustomParams](#dccustomparams) | False | - | - labels | Map<String, String> | False | - | - resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## ContainerResourceEachSpec -#### Parent types: +### Parent types: - [ContainerResourceSpec](#containerresourcespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- cpu | Nullable<Positive<NonZero<Number>>> | False | <unknown transformation> | - memory | Nullable<Memory> | False | - | - ## StorageClass -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -693,9 +787,9 @@ name | Identifier | True | - | - parameters | Map<String, String> | False | - | - provisioner | String | False | - | - ## DCRollingParams -#### Parent types: +### Parent types: - [DCRollingStrategy](#dcrollingstrategy) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -707,22 +801,22 @@ pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - updatePeriodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## SCCGroupRange -#### Parent types: +### Parent types: - [SCCGroups](#sccgroups) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- max | Positive<NonZero<Integer>> | False | - | - min | Positive<NonZero<Integer>> | False | - | - ## DCCustomParams -#### Parents: +### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) -#### Parent types: +### Parent types: - [DCCustomStrategy](#dccustomstrategy) - [DCRecreateStrategy](#dcrecreatestrategy) - [DCRollingStrategy](#dcrollingstrategy) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -730,10 +824,10 @@ command | Nullable<List<String>> | False | - | - environment | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - image | NonEmpty<String> | False | - | - ## ContainerVolumeMountSpec -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) - [DCLifecycleNewPod](#dclifecyclenewpod) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -741,15 +835,15 @@ name | Identifier | False | - | - path | NonEmpty<Path> | False | - | - readOnly | Nullable<Boolean> | False | - | - ## LifeCycleProbe -#### Children: +### Children: - [LifeCycleExec](#lifecycleexec) - [LifeCycleHTTP](#lifecyclehttp) -#### Parent types: +### Parent types: - [LifeCycle](#lifecycle) ## SASecretSubject -#### Parent types: +### Parent types: - [ServiceAccount](#serviceaccount) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -757,18 +851,18 @@ kind | Nullable<CaseIdentifier> | False | - | - name | Nullable<Identifier> | False | - | - ns | Nullable<Identifier> | False | - | - ## PodTemplateSpec -#### Parent types: +### Parent types: - [DaemonSet](#daemonset) - [Deployment](#deployment) - [DeploymentConfig](#deploymentconfig) - [Job](#job) - [ReplicationController](#replicationcontroller) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -786,12 +880,12 @@ serviceAccountName | Nullable<Identifier> | False | <unknown transforma terminationGracePeriodSeconds | Nullable<Positive<Integer>> | False | - | - volumes | Nullable<List<[PodVolumeBaseSpec](#podvolumebasespec)>> | False | - | - ## User -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -799,13 +893,13 @@ name | UserIdentifier | True | - | - fullName | Nullable<String> | False | - | - identities | NonEmpty<List<NonEmpty<String>>> | False | - | - ## ContainerEnvConfigMapSpec -#### Parents: +### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) - [DCCustomParams](#dccustomparams) - [DCLifecycleNewPod](#dclifecyclenewpod) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -813,21 +907,21 @@ key | NonEmpty<String> | False | - | - map_name | Identifier | False | - | - name | EnvString | False | - | - ## LifeCycleExec -#### Parents: +### Parents: - [LifeCycleProbe](#lifecycleprobe) -#### Parent types: +### Parent types: - [LifeCycle](#lifecycle) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- command | NonEmpty<List<String>> | False | - | - ## DCRollingStrategy -#### Parents: +### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) -#### Parent types: +### Parent types: - [DeploymentConfig](#deploymentconfig) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -838,23 +932,23 @@ labels | Map<String, String> | False | - | - resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - rollingParams | Nullable<[DCRollingParams](#dcrollingparams)> | False | - | - ## RouteDest -#### Children: +### Children: - [RouteDestService](#routedestservice) -#### Parent types: +### Parent types: - [Route](#route) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- weight | Positive<NonZero<Integer>> | False | - | - ## ContainerEnvPodFieldSpec -#### Parents: +### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) - [DCCustomParams](#dccustomparams) - [DCLifecycleNewPod](#dclifecyclenewpod) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -862,12 +956,12 @@ apiVersion | Nullable<Enum('v1')> | False | - | - fieldPath | Enum('metadata.name', 'metadata.namespace', 'metadata.labels', 'metadata.annotations', 'spec.nodeName', 'spec.serviceAccountName', 'status.podIP') | False | - | - name | EnvString | False | - | - ## ServiceAccount -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -875,39 +969,39 @@ name | Identifier | True | - | - imagePullSecrets | Nullable<List<[SAImgPullSecretSubject](#saimgpullsecretsubject)>> | False | <unknown transformation> | - secrets | Nullable<List<[SASecretSubject](#sasecretsubject)>> | False | <unknown transformation> | - ## PodVolumeBaseSpec -#### Children: +### Children: - [PodVolumeHostSpec](#podvolumehostspec) - [PodVolumeItemMapper](#podvolumeitemmapper) - [PodVolumePVCSpec](#podvolumepvcspec) - [PodVolumeEmptyDirSpec](#podvolumeemptydirspec) - [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) - [PodVolumeSecretSpec](#podvolumesecretspec) -#### Parent types: +### Parent types: - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | False | - | - ## ClusterRole -#### Parents: +### Parents: - [RoleBase](#rolebase) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ## DCLifecycleHook -#### Parent types: +### Parent types: - [DCRecreateParams](#dcrecreateparams) - [DCRollingParams](#dcrollingparams) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -915,14 +1009,14 @@ execNewPod | Nullable<[DCLifecycleNewPod](#dclifecyclenewpod)> | False | - failurePolicy | Enum('Abort', 'Retry', 'Ignore') | False | - | - tagImages | Nullable<[DCTagImages](#dctagimages)> | False | - | - ## ClusterIPService -#### Parents: +### Parents: - [Service](#service) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -932,9 +1026,9 @@ ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <un selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ## PersistentVolumeRef -#### Parent types: +### Parent types: - [PersistentVolume](#persistentvolume) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -943,11 +1037,11 @@ kind | Nullable<CaseIdentifier> | False | - | - name | Nullable<Identifier> | False | - | - ns | Nullable<Identifier> | False | - | - ## DCLifecycleNewPod -#### Parents: +### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) -#### Parent types: +### Parent types: - [DCLifecycleHook](#dclifecyclehook) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -957,11 +1051,11 @@ env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | - | - volumes | Nullable<List<Identifier>> | False | - | - ## ContainerProbeTCPPortSpec -#### Parents: +### Parents: - [ContainerProbeBaseSpec](#containerprobebasespec) -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -972,36 +1066,36 @@ port | Positive<NonZero<Integer>> | False | <unknown transformati successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## ContainerEnvBaseSpec -#### Children: +### Children: - [ContainerEnvSpec](#containerenvspec) - [ContainerEnvConfigMapSpec](#containerenvconfigmapspec) - [ContainerEnvSecretSpec](#containerenvsecretspec) - [ContainerEnvPodFieldSpec](#containerenvpodfieldspec) - [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) - [DCCustomParams](#dccustomparams) - [DCLifecycleNewPod](#dclifecyclenewpod) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | EnvString | False | - | - ## PodVolumeHostSpec -#### Parents: +### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: +### Parent types: - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | False | - | - path | String | False | - | - ## DCRecreateParams -#### Parent types: +### Parent types: - [DCRecreateStrategy](#dcrecreatestrategy) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1010,9 +1104,9 @@ post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## DCTagImages -#### Parent types: +### Parent types: - [DCLifecycleHook](#dclifecyclehook) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1025,15 +1119,15 @@ toNamespace | Nullable<Identifier> | False | - | - toResourceVersion | Nullable<String> | False | - | - toUid | Nullable<String> | False | - | - ## Secret -#### Children: +### Children: - [DockerCredentials](#dockercredentials) - [TLSCredentials](#tlscredentials) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1041,28 +1135,28 @@ name | Identifier | True | - | - secrets | Map<String, String> | False | - | - type | NonEmpty<String> | False | - | - ## RouteDestPort -#### Parent types: +### Parent types: - [Route](#route) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- targetPort | Identifier | False | - | - ## BaseSelector -#### Children: +### Children: - [MatchLabelsSelector](#matchlabelsselector) - [MatchExpressionsSelector](#matchexpressionsselector) -#### Parent types: +### Parent types: - [DaemonSet](#daemonset) - [Deployment](#deployment) - [Job](#job) - [PersistentVolumeClaim](#persistentvolumeclaim) ## ContainerProbeHTTPSpec -#### Parents: +### Parents: - [ContainerProbeBaseSpec](#containerprobebasespec) -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1076,11 +1170,11 @@ scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - ## ServicePort -#### Parent types: +### Parent types: - [AWSLoadBalancerService](#awsloadbalancerservice) - [ClusterIPService](#clusteripservice) - [Service](#service) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1089,21 +1183,21 @@ port | Positive<NonZero<Integer>> | False | - | - protocol | Enum('TCP', 'UDP') | False | - | - targetPort | OneOf<Positive<NonZero<Integer>>, Identifier> | False | - | - ## AWSElasticBlockStore -#### Parent types: +### Parent types: - [PersistentVolume](#persistentvolume) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- fsType | Enum('ext4') | False | - | - volumeID | AWSVolID | False | - | - ## ReplicationController -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1113,9 +1207,9 @@ pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - replicas | Positive<NonZero<Integer>> | False | - | - selector | Nullable<Map<String, String>> | False | - | - ## SAImgPullSecretSubject -#### Parent types: +### Parent types: - [ServiceAccount](#serviceaccount) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1128,12 +1222,12 @@ A Deployment controller provides declarative updates for Pods and ReplicaSets. You describe a desired state in a Deployment object, and the Deployment controller changes the actual state to the desired state at a controlled rate. You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments. -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1147,20 +1241,20 @@ revisionHistoryLimit | Nullable<Positive<NonZero<Integer>>> | selector | Nullable<[BaseSelector](#baseselector)> | False | - | - strategy | Nullable<[DplBaseUpdateStrategy](#dplbaseupdatestrategy)> | False | - | - ## PodImagePullSecret -#### Parent types: +### Parent types: - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | False | - | - ## RoleSubject -#### Parent types: +### Parent types: - [ClusterRoleBinding](#clusterrolebinding) - [PolicyBindingRoleBinding](#policybindingrolebinding) - [RoleBinding](#rolebinding) - [RoleBindingBase](#rolebindingbase) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1168,12 +1262,12 @@ kind | CaseIdentifier | False | - | - name | String | False | - | - ns | Nullable<Identifier> | False | - | - ## SecurityContextConstraints -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1198,12 +1292,12 @@ supplementalGroups | Nullable<[SCCGroups](#sccgroups)> | False | - | - users | List<SystemIdentifier> | False | - | - volumes | List<Enum('configMap', 'downwardAPI', 'emptyDir', 'hostPath', 'nfs', 'persistentVolumeClaim', 'secret', '*')> | False | - | - ## Route -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1214,24 +1308,24 @@ tls | Nullable<[RouteTLS](#routetls)> | False | - | - to | NonEmpty<List<[RouteDest](#routedest)>> | False | - | - wildcardPolicy | Enum('Subdomain', 'None') | False | - | - ## ContainerResourceSpec -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) - [DCCustomStrategy](#dccustomstrategy) - [DCRecreateStrategy](#dcrecreatestrategy) - [DCRollingStrategy](#dcrollingstrategy) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- limits | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - requests | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - ## PolicyBindingRoleBinding -#### Parents: +### Parents: - [RoleBindingXF](#rolebindingxf) -#### Parent types: +### Parent types: - [PolicyBinding](#policybinding) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1241,24 +1335,24 @@ ns | Identifier | False | - | - roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## LifeCycle -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- postStart | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - preStop | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - ## RoleBinding -#### Parents: +### Parents: - [RoleBindingBase](#rolebindingbase) - [RoleBindingXF](#rolebindingxf) -#### Metadata +### Metadata Name | Format ---- | ------ annotations | Map labels | Map -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1266,24 +1360,24 @@ name | SystemIdentifier | True | - | - roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## MatchLabelsSelector -#### Parents: +### Parents: - [BaseSelector](#baseselector) -#### Parent types: +### Parent types: - [DaemonSet](#daemonset) - [Deployment](#deployment) - [Job](#job) - [PersistentVolumeClaim](#persistentvolumeclaim) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- matchLabels | Map<String, String> | False | - | - ## PolicyRule -#### Parent types: +### Parent types: - [ClusterRole](#clusterrole) - [Role](#role) - [RoleBase](#rolebase) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1294,13 +1388,13 @@ resourceNames | Nullable<List<String>> | False | - | - resources | NonEmpty<List<NonEmpty<String>>> | False | - | - verbs | NonEmpty<List<Enum('get', 'list', 'create', 'update', 'delete', 'deletecollection', 'watch')>> | False | - | - ## ContainerEnvContainerResourceSpec -#### Parents: +### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) -#### Parent types: +### Parent types: - [ContainerSpec](#containerspec) - [DCCustomParams](#dccustomparams) - [DCLifecycleNewPod](#dclifecyclenewpod) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- @@ -1309,12 +1403,12 @@ divisor | Nullable<NonEmpty<String>> | False | - | - name | EnvString | False | - | - resource | Enum('limits.cpu', 'limits.memory', 'requests.cpu', 'requests.memory') | False | - | - ## PodVolumeSecretSpec -#### Parents: +### Parents: - [PodVolumeItemMapper](#podvolumeitemmapper) - [PodVolumeBaseSpec](#podvolumebasespec) -#### Parent types: +### Parent types: - [PodTemplateSpec](#podtemplatespec) -#### Properties: +### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index 975fe52..b50b5ba 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -22,18 +22,29 @@ def populate_args(self, parser): def run(self, args): objs = load_python.PythonBaseFile.get_kube_objs() + types = load_python.PythonBaseFile.get_kube_types() + r = self.get_repository() + doc = '\n'.join([line.strip() for line in self._description.split('\n')]) md = '' header = '# Rubiks Object Index\n{}\n\n'.format(doc) header += '# Table of contents\n\n' + header += '- [Types](#types)\n' + md += '\n# Types\n\n' + for tname in types.keys(): + header += ' - [{}](#{})\n'.format(tname, tname.lower()) + md += '## {}\n\n'.format(tname) + md += '{}\n\n'.format(types[tname].get_description()) + + header += '- [Objects](#objects)\n' + md += '\n# Objects\n\n' for oname in objs.keys(): header += ' - [{}](#{})\n'.format(oname, oname.lower()) md += objs[oname].get_help().render_markdown() - header += '\n# Objects\n\n' with open(os.path.join(r.basepath, 'docs/rubiks.class.md'), 'w') as f: f.write(header) diff --git a/lib/kube_help.py b/lib/kube_help.py index 72cc4aa..adaaa47 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -131,25 +131,25 @@ def render_markdown(self): # Parents if len(self.class_superclasses) != 0: - txt += '#### Parents: \n' + txt += '### Parents: \n' for obj in self._get_markdown_link(self.class_superclasses): txt += '- {}\n'.format(obj) # Children if len(self.class_subclasses) != 0: - txt += '#### Children: \n' + txt += '### Children: \n' for obj in self._get_markdown_link(self.class_subclasses): txt += '- {}\n'.format(obj) # Parent types if len(self.class_parent_types) != 0: - txt += '#### Parent types: \n' + txt += '### Parent types: \n' for obj in self._get_markdown_link(sorted(self.class_parent_types.keys())): txt += '- {}\n'.format(obj) # Metadata if self.class_has_metadata: - txt += '#### Metadata\n' + txt += '### Metadata\n' txt += 'Name | Format\n' txt += '---- | ------\n' txt += 'annotations | {}\n'.format(Map(String, String).name()) @@ -159,7 +159,7 @@ def render_markdown(self): if len(self.class_types.keys()) == 0: return txt - txt += '#### Properties:\n\n' + txt += '### Properties:\n\n' txt += 'Name | Type | Identifier | Type Transformation | Aliases\n' txt += '---- | ---- | ---------- | ------------------- | -------\n' if self.class_identifier is not None: diff --git a/lib/kube_types.py b/lib/kube_types.py index 74272a9..d6f2e4d 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -52,6 +52,12 @@ def construct_arg(cls, arg): return ret + @classmethod + def get_description(cls): + if cls.__doc__ is not None and cls.__doc__ is not '': + return '\n'.join([line.strip() for line in cls.__doc__.split('\n')]) + return 'TODO: Description is still missing from the class docstring.\nStay tuned to have more hint about this variable.' + def original_type(self): if self.wrapper: return self.wrap.original_type() diff --git a/lib/load_python.py b/lib/load_python.py index a4ad162..a699865 100644 --- a/lib/load_python.py +++ b/lib/load_python.py @@ -15,7 +15,7 @@ import kube_yaml from load_python_core import do_compile_internal -from kube_obj import KubeObj, KubeBaseObj +from kube_obj import KubeObj, KubeBaseObj, KubeType from obj_registry import obj_registry, get_ns from user_error import UserError, user_originated, handle_user_error from output import RubiksOutputError, OutputCollection @@ -23,6 +23,7 @@ from util import mkdir_p import kube_objs +import kube_types import kube_vartypes @@ -209,6 +210,7 @@ def gen_output(self): class PythonBaseFile(object): _kube_objs = None _kube_vartypes = None + _kube_type = None compile_in_init = True default_export_objects = False can_cluster_context = True @@ -242,6 +244,21 @@ def get_kube_vartypes(cls): pass return cls._kube_vartypes + @classmethod + def get_kube_types(cls): + if cls._kube_type is None: + cls._kube_type = {} + + for k in kube_types.__dict__: + if isinstance(kube_types.__dict__[k], type) and k not in ('KubeType'): + try: + if isinstance(kube_objs.__dict__[k](), KubeType): + cls._kube_type[k] = kube_types.__dict__[k] + except: + pass + + return cls._kube_type + def __init__(self, collection, path): if path.basename == '' or path.basename.lower().strip('0123456789abcdefghijklmnopqrstuvwxyz_') != '': raise UserError(ValueError( @@ -502,6 +519,7 @@ def cluster_info(c): ret.update(self.__class__.get_kube_objs()) ret.update(self.__class__.get_kube_vartypes()) + ret.update(self.__class__.get_kube_types()) self.reserved_names = tuple(ret.keys()) From eb26bb0aba7373d656c7abdced29bac03338d5fa Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 15:27:38 +0200 Subject: [PATCH 15/40] Added vartypes --- docs/rubiks.class.md | 34 ++++++++++++++++++++++++++++++++++ lib/commands/docgen.py | 8 ++++++++ lib/var_types.py | 6 ++++++ 3 files changed, 48 insertions(+) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index df3b6a8..562d4f6 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -5,6 +5,12 @@ This document is automatically generated using the command `docgen` and describe # Table of contents +- [Formats](#formats) + - [YAML](#yaml) + - [JSON](#json) + - [Base64](#base64) + - [Command](#command) + - [Confidential](#confidential) - [Types](#types) - [ColonIdentifier](#colonidentifier) - [Domain](#domain) @@ -115,6 +121,34 @@ This document is automatically generated using the command `docgen` and describe - [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) - [PodVolumeSecretSpec](#podvolumesecretspec) +# Formats + +## YAML + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## JSON + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Base64 + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Command + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## Confidential + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + + # Types ## ColonIdentifier diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index b50b5ba..eb33af6 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -23,6 +23,7 @@ def populate_args(self, parser): def run(self, args): objs = load_python.PythonBaseFile.get_kube_objs() types = load_python.PythonBaseFile.get_kube_types() + formats = load_python.PythonBaseFile.get_kube_vartypes() r = self.get_repository() @@ -32,6 +33,13 @@ def run(self, args): header = '# Rubiks Object Index\n{}\n\n'.format(doc) header += '# Table of contents\n\n' + header += '- [Formats](#formats)\n' + md += '\n# Formats\n\n' + for fname in formats.keys(): + header += ' - [{}](#{})\n'.format(fname, fname.lower()) + md += '## {}\n\n'.format(fname) + md += '{}\n\n'.format(formats[fname].get_description()) + header += '- [Types](#types)\n' md += '\n# Types\n\n' for tname in types.keys(): diff --git a/lib/var_types.py b/lib/var_types.py index 7c6ac70..de010c7 100644 --- a/lib/var_types.py +++ b/lib/var_types.py @@ -118,3 +118,9 @@ def __str__(self): if self.renderer is None: return self._internal_render() return self.renderer(self._internal_render()) + + @classmethod + def get_description(cls): + if cls.__doc__ is not None and cls.__doc__ is not '': + return '\n'.join([line.strip() for line in cls.__doc__.split('\n')]) + return 'TODO: Description is still missing from the class docstring.\nStay tuned to have more hint about this variable.' From ba25eed320a3ac31019701f3c3da812543c65b47 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 15:48:01 +0200 Subject: [PATCH 16/40] Change order of objects --- docs/rubiks.class.md | 1598 ++++++++++++++++++++-------------------- lib/commands/docgen.py | 6 +- 2 files changed, 802 insertions(+), 802 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 562d4f6..d1d43f2 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -6,144 +6,144 @@ This document is automatically generated using the command `docgen` and describe # Table of contents - [Formats](#formats) - - [YAML](#yaml) - - [JSON](#json) - [Base64](#base64) - [Command](#command) - [Confidential](#confidential) + - [JSON](#json) + - [YAML](#yaml) - [Types](#types) + - [ARN](#arn) + - [Boolean](#boolean) + - [CaseIdentifier](#caseidentifier) - [ColonIdentifier](#colonidentifier) - [Domain](#domain) - - [CaseIdentifier](#caseidentifier) - - [String](#string) - - [IP](#ip) - - [SurgeSpec](#surgespec) - [Enum](#enum) - - [Number](#number) - - [Boolean](#boolean) + - [IP](#ip) - [IPv4](#ipv4) - - [Path](#path) - - [Integer](#integer) - [Identifier](#identifier) - - [ARN](#arn) + - [Integer](#integer) + - [Number](#number) + - [Path](#path) + - [String](#string) + - [SurgeSpec](#surgespec) - [SystemIdentifier](#systemidentifier) - [Objects](#objects) - - [TLSCredentials](#tlscredentials) - - [Service](#service) - - [DockerCredentials](#dockercredentials) - - [DplBaseUpdateStrategy](#dplbaseupdatestrategy) - - [Role](#role) - - [Group](#group) - - [RouteTLS](#routetls) - - [SCCRunAsUser](#sccrunasuser) - - [PersistentVolumeClaim](#persistentvolumeclaim) - - [PodVolumePVCSpec](#podvolumepvcspec) - - [DCConfigChangeTrigger](#dcconfigchangetrigger) - - [SecurityContext](#securitycontext) - - [Project](#project) - - [PersistentVolume](#persistentvolume) - - [DeploymentConfig](#deploymentconfig) - - [ContainerPort](#containerport) - - [DCImageChangeTrigger](#dcimagechangetrigger) - - [RoleRef](#roleref) - - [LifeCycleHTTP](#lifecyclehttp) - - [PodVolumeItemMapper](#podvolumeitemmapper) - - [DaemonSet](#daemonset) - - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) - - [Namespace](#namespace) - - [ContainerEnvSpec](#containerenvspec) - - [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) - - [MatchExpression](#matchexpression) - - [SCCSELinux](#sccselinux) - - [ClusterRoleBinding](#clusterrolebinding) + - [AWSElasticBlockStore](#awselasticblockstore) - [AWSLoadBalancerService](#awsloadbalancerservice) - - [Job](#job) - - [RouteDestService](#routedestservice) - - [DCRecreateStrategy](#dcrecreatestrategy) - - [DplRollingUpdateStrategy](#dplrollingupdatestrategy) - - [ContainerSpec](#containerspec) - - [DplRecreateStrategy](#dplrecreatestrategy) - - [DCTrigger](#dctrigger) + - [BaseSelector](#baseselector) + - [ClusterIPService](#clusteripservice) + - [ClusterRole](#clusterrole) + - [ClusterRoleBinding](#clusterrolebinding) + - [ConfigMap](#configmap) + - [ContainerEnvBaseSpec](#containerenvbasespec) + - [ContainerEnvConfigMapSpec](#containerenvconfigmapspec) + - [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) + - [ContainerEnvPodFieldSpec](#containerenvpodfieldspec) - [ContainerEnvSecretSpec](#containerenvsecretspec) - - [MatchExpressionsSelector](#matchexpressionsselector) + - [ContainerEnvSpec](#containerenvspec) + - [ContainerPort](#containerport) - [ContainerProbeBaseSpec](#containerprobebasespec) - - [PodVolumeEmptyDirSpec](#podvolumeemptydirspec) - - [PolicyBinding](#policybinding) - - [ConfigMap](#configmap) - - [SCCGroups](#sccgroups) - - [DCCustomStrategy](#dccustomstrategy) + - [ContainerProbeHTTPSpec](#containerprobehttpspec) + - [ContainerProbeTCPPortSpec](#containerprobetcpportspec) - [ContainerResourceEachSpec](#containerresourceeachspec) - - [StorageClass](#storageclass) - - [DCRollingParams](#dcrollingparams) - - [SCCGroupRange](#sccgrouprange) - - [DCCustomParams](#dccustomparams) + - [ContainerResourceSpec](#containerresourcespec) + - [ContainerSpec](#containerspec) - [ContainerVolumeMountSpec](#containervolumemountspec) - - [LifeCycleProbe](#lifecycleprobe) - - [SASecretSubject](#sasecretsubject) - - [PodTemplateSpec](#podtemplatespec) - - [User](#user) - - [ContainerEnvConfigMapSpec](#containerenvconfigmapspec) - - [LifeCycleExec](#lifecycleexec) - - [DCRollingStrategy](#dcrollingstrategy) - - [RouteDest](#routedest) - - [ContainerEnvPodFieldSpec](#containerenvpodfieldspec) - - [ServiceAccount](#serviceaccount) - - [PodVolumeBaseSpec](#podvolumebasespec) - - [ClusterRole](#clusterrole) + - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) + - [DCConfigChangeTrigger](#dcconfigchangetrigger) + - [DCCustomParams](#dccustomparams) + - [DCCustomStrategy](#dccustomstrategy) + - [DCImageChangeTrigger](#dcimagechangetrigger) - [DCLifecycleHook](#dclifecyclehook) - - [ClusterIPService](#clusteripservice) - - [PersistentVolumeRef](#persistentvolumeref) - [DCLifecycleNewPod](#dclifecyclenewpod) - - [ContainerProbeTCPPortSpec](#containerprobetcpportspec) - - [ContainerEnvBaseSpec](#containerenvbasespec) - - [PodVolumeHostSpec](#podvolumehostspec) - [DCRecreateParams](#dcrecreateparams) + - [DCRecreateStrategy](#dcrecreatestrategy) + - [DCRollingParams](#dcrollingparams) + - [DCRollingStrategy](#dcrollingstrategy) - [DCTagImages](#dctagimages) - - [Secret](#secret) - - [RouteDestPort](#routedestport) - - [BaseSelector](#baseselector) - - [ContainerProbeHTTPSpec](#containerprobehttpspec) - - [ServicePort](#serviceport) - - [AWSElasticBlockStore](#awselasticblockstore) - - [ReplicationController](#replicationcontroller) - - [SAImgPullSecretSubject](#saimgpullsecretsubject) + - [DCTrigger](#dctrigger) + - [DaemonSet](#daemonset) - [Deployment](#deployment) - - [PodImagePullSecret](#podimagepullsecret) - - [RoleSubject](#rolesubject) - - [SecurityContextConstraints](#securitycontextconstraints) - - [Route](#route) - - [ContainerResourceSpec](#containerresourcespec) - - [PolicyBindingRoleBinding](#policybindingrolebinding) + - [DeploymentConfig](#deploymentconfig) + - [DockerCredentials](#dockercredentials) + - [DplBaseUpdateStrategy](#dplbaseupdatestrategy) + - [DplRecreateStrategy](#dplrecreatestrategy) + - [DplRollingUpdateStrategy](#dplrollingupdatestrategy) + - [Group](#group) + - [Job](#job) - [LifeCycle](#lifecycle) - - [RoleBinding](#rolebinding) + - [LifeCycleExec](#lifecycleexec) + - [LifeCycleHTTP](#lifecyclehttp) + - [LifeCycleProbe](#lifecycleprobe) + - [MatchExpression](#matchexpression) + - [MatchExpressionsSelector](#matchexpressionsselector) - [MatchLabelsSelector](#matchlabelsselector) - - [PolicyRule](#policyrule) - - [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) + - [Namespace](#namespace) + - [PersistentVolume](#persistentvolume) + - [PersistentVolumeClaim](#persistentvolumeclaim) + - [PersistentVolumeRef](#persistentvolumeref) + - [PodImagePullSecret](#podimagepullsecret) + - [PodTemplateSpec](#podtemplatespec) + - [PodVolumeBaseSpec](#podvolumebasespec) + - [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) + - [PodVolumeEmptyDirSpec](#podvolumeemptydirspec) + - [PodVolumeHostSpec](#podvolumehostspec) + - [PodVolumeItemMapper](#podvolumeitemmapper) + - [PodVolumePVCSpec](#podvolumepvcspec) - [PodVolumeSecretSpec](#podvolumesecretspec) + - [PolicyBinding](#policybinding) + - [PolicyBindingRoleBinding](#policybindingrolebinding) + - [PolicyRule](#policyrule) + - [Project](#project) + - [ReplicationController](#replicationcontroller) + - [Role](#role) + - [RoleBinding](#rolebinding) + - [RoleRef](#roleref) + - [RoleSubject](#rolesubject) + - [Route](#route) + - [RouteDest](#routedest) + - [RouteDestPort](#routedestport) + - [RouteDestService](#routedestservice) + - [RouteTLS](#routetls) + - [SAImgPullSecretSubject](#saimgpullsecretsubject) + - [SASecretSubject](#sasecretsubject) + - [SCCGroupRange](#sccgrouprange) + - [SCCGroups](#sccgroups) + - [SCCRunAsUser](#sccrunasuser) + - [SCCSELinux](#sccselinux) + - [Secret](#secret) + - [SecurityContext](#securitycontext) + - [SecurityContextConstraints](#securitycontextconstraints) + - [Service](#service) + - [ServiceAccount](#serviceaccount) + - [ServicePort](#serviceport) + - [StorageClass](#storageclass) + - [TLSCredentials](#tlscredentials) + - [User](#user) # Formats -## YAML +## Base64 TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## JSON +## Command TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Base64 +## Confidential TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Command +## JSON TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Confidential +## YAML TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. @@ -151,12 +151,12 @@ Stay tuned to have more hint about this variable. # Types -## ColonIdentifier +## ARN TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Domain +## Boolean TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. @@ -166,57 +166,57 @@ Stay tuned to have more hint about this variable. TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## String +## ColonIdentifier TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## IP +## Domain TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## SurgeSpec +## Enum TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Enum +## IP TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Number +## IPv4 TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Boolean +## Identifier TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## IPv4 +## Integer TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Path +## Number TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Integer +## Path TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## Identifier +## String TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. -## ARN +## SurgeSpec TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. @@ -229,9 +229,18 @@ Stay tuned to have more hint about this variable. # Objects -## TLSCredentials +## AWSElasticBlockStore +### Parent types: +- [PersistentVolume](#persistentvolume) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +fsType | Enum('ext4') | False | - | - +volumeID | AWSVolID | False | - | - +## AWSLoadBalancerService ### Parents: -- [Secret](#secret) +- [Service](#service) ### Metadata Name | Format ---- | ------ @@ -242,14 +251,24 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -secrets | Map<String, String> | False | - | - -tls_cert | String | False | - | - -tls_key | String | False | - | - -type | NonEmpty<String> | False | - | - -## Service +aws-load-balancer-backend-protocol | Nullable<Identifier> | False | - | - +aws-load-balancer-ssl-cert | Nullable<ARN> | False | - | - +externalTrafficPolicy | Nullable<Enum('Cluster', 'Local')> | False | - | - +ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - +selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - +sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - +## BaseSelector ### Children: -- [ClusterIPService](#clusteripservice) -- [AWSLoadBalancerService](#awsloadbalancerservice) +- [MatchLabelsSelector](#matchlabelsselector) +- [MatchExpressionsSelector](#matchexpressionsselector) +### Parent types: +- [DaemonSet](#daemonset) +- [Deployment](#deployment) +- [Job](#job) +- [PersistentVolumeClaim](#persistentvolumeclaim) +## ClusterIPService +### Parents: +- [Service](#service) ### Metadata Name | Format ---- | ------ @@ -260,12 +279,13 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - +clusterIP | Nullable<IPv4> | False | - | - ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - -## DockerCredentials +## ClusterRole ### Parents: -- [Secret](#secret) +- [RoleBase](#rolebase) ### Metadata Name | Format ---- | ------ @@ -276,18 +296,11 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -dockers | Map<String, Map<String, String>> | False | - | - -secrets | Map<String, String> | False | - | - -type | NonEmpty<String> | False | - | - -## DplBaseUpdateStrategy -### Children: -- [DplRecreateStrategy](#dplrecreatestrategy) -- [DplRollingUpdateStrategy](#dplrollingupdatestrategy) -### Parent types: -- [Deployment](#deployment) -## Role +rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - +## ClusterRoleBinding ### Parents: -- [RoleBase](#rolebase) +- [RoleBindingBase](#rolebindingbase) +- [RoleBindingXF](#rolebindingxf) ### Metadata Name | Format ---- | ------ @@ -298,8 +311,9 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - -## Group +roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - +subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - +## ConfigMap ### Metadata Name | Format ---- | ------ @@ -310,124 +324,93 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -users | NonEmpty<List<UserIdentifier>> | False | - | - -## RouteTLS +files | Map<String, String> | False | - | - +## ContainerEnvBaseSpec +### Children: +- [ContainerEnvSpec](#containerenvspec) +- [ContainerEnvConfigMapSpec](#containerenvconfigmapspec) +- [ContainerEnvSecretSpec](#containerenvsecretspec) +- [ContainerEnvPodFieldSpec](#containerenvpodfieldspec) +- [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) ### Parent types: -- [Route](#route) +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -caCertificate | Nullable<NonEmpty<String>> | False | - | - -certificate | Nullable<NonEmpty<String>> | False | - | - -destinationCACertificate | Nullable<NonEmpty<String>> | False | - | - -insecureEdgeTerminationPolicy | Enum('Allow', 'Disable', 'Redirect') | False | - | - -key | Nullable<NonEmpty<String>> | False | - | - -termination | Enum('edge', 'reencrypt', 'passthrough') | False | - | - -## SCCRunAsUser +name | EnvString | False | - | - +## ContainerEnvConfigMapSpec +### Parents: +- [ContainerEnvBaseSpec](#containerenvbasespec) ### Parent types: -- [SecurityContextConstraints](#securitycontextconstraints) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -type | Enum('MustRunAs', 'RunAsAny', 'MustRunAsRange', 'MustRunAsNonRoot') | False | - | - -uid | Nullable<Positive<NonZero<Integer>>> | False | - | - -uidRangeMax | Nullable<Positive<NonZero<Integer>>> | False | - | - -uidRangeMin | Nullable<Positive<NonZero<Integer>>> | False | - | - -## PersistentVolumeClaim -### Metadata -Name | Format ----- | ------ -annotations | Map -labels | Map +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - -request | Memory | False | - | - -selector | Nullable<[BaseSelector](#baseselector)> | False | - | - -volumeName | Nullable<Identifier> | False | <unknown transformation> | - -## PodVolumePVCSpec +key | NonEmpty<String> | False | - | - +map_name | Identifier | False | - | - +name | EnvString | False | - | - +## ContainerEnvContainerResourceSpec ### Parents: -- [PodVolumeBaseSpec](#podvolumebasespec) +- [ContainerEnvBaseSpec](#containerenvbasespec) ### Parent types: -- [PodTemplateSpec](#podtemplatespec) +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -claimName | Identifier | False | - | - -name | Identifier | False | - | - -## DCConfigChangeTrigger +containerName | Nullable<Identifier> | False | - | - +divisor | Nullable<NonEmpty<String>> | False | - | - +name | EnvString | False | - | - +resource | Enum('limits.cpu', 'limits.memory', 'requests.cpu', 'requests.memory') | False | - | - +## ContainerEnvPodFieldSpec ### Parents: -- [DCTrigger](#dctrigger) -### Parent types: -- [DeploymentConfig](#deploymentconfig) -## SecurityContext +- [ContainerEnvBaseSpec](#containerenvbasespec) ### Parent types: - [ContainerSpec](#containerspec) -- [PodTemplateSpec](#podtemplatespec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -fsGroup | Nullable<Integer> | False | - | - -privileged | Nullable<Boolean> | False | - | - -runAsNonRoot | Nullable<Boolean> | False | - | - -runAsUser | Nullable<Integer> | False | - | - -supplementalGroups | Nullable<List<Integer>> | False | - | - -## Project +apiVersion | Nullable<Enum('v1')> | False | - | - +fieldPath | Enum('metadata.name', 'metadata.namespace', 'metadata.labels', 'metadata.annotations', 'spec.nodeName', 'spec.serviceAccountName', 'status.podIP') | False | - | - +name | EnvString | False | - | - +## ContainerEnvSecretSpec ### Parents: -- [Namespace](#namespace) -### Metadata -Name | Format ----- | ------ -annotations | Map -labels | Map -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -## PersistentVolume -### Metadata -Name | Format ----- | ------ -annotations | Map -labels | Map +- [ContainerEnvBaseSpec](#containerenvbasespec) +### Parent types: +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - -awsElasticBlockStore | Nullable<[AWSElasticBlockStore](#awselasticblockstore)> | False | - | - -capacity | Memory | False | - | - -claimRef | Nullable<[PersistentVolumeRef](#persistentvolumeref)> | False | - | - -persistentVolumeReclaimPolicy | Nullable<Enum('Retain', 'Recycle', 'Delete')> | False | - | - -## DeploymentConfig -### Metadata -Name | Format ----- | ------ -annotations | Map -labels | Map +key | NonEmpty<String> | False | - | - +name | EnvString | False | - | - +secret_name | Identifier | False | - | - +## ContainerEnvSpec +### Parents: +- [ContainerEnvBaseSpec](#containerenvbasespec) +### Parent types: +- [ContainerSpec](#containerspec) +- [DCCustomParams](#dccustomparams) +- [DCLifecycleNewPod](#dclifecyclenewpod) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -paused | Nullable<Boolean> | False | - | - -pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -replicas | Positive<NonZero<Integer>> | False | - | - -revisionHistoryLimit | Nullable<Positive<NonZero<Integer>>> | False | - | - -selector | Nullable<Map<String, String>> | False | - | - -strategy | [DCBaseUpdateStrategy](#dcbaseupdatestrategy) | False | - | - -test | Boolean | False | - | - -triggers | List<[DCTrigger](#dctrigger)> | False | - | - +name | EnvString | False | - | - +value | String | False | - | - ## ContainerPort ### Parent types: - [ContainerSpec](#containerspec) @@ -440,145 +423,268 @@ hostIP | Nullable<IP> | False | - | - hostPort | Nullable<Positive<NonZero<Integer>>> | False | - | - name | Nullable<String> | False | - | - protocol | Enum('TCP', 'UDP') | False | - | - -## DCImageChangeTrigger -### Parents: -- [DCTrigger](#dctrigger) -### Parent types: -- [DeploymentConfig](#deploymentconfig) -## RoleRef +## ContainerProbeBaseSpec +### Children: +- [ContainerProbeTCPPortSpec](#containerprobetcpportspec) +- [ContainerProbeHTTPSpec](#containerprobehttpspec) ### Parent types: -- [ClusterRoleBinding](#clusterrolebinding) -- [PolicyBindingRoleBinding](#policybindingrolebinding) -- [RoleBinding](#rolebinding) -- [RoleBindingBase](#rolebindingbase) +- [ContainerSpec](#containerspec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Nullable<SystemIdentifier> | False | - | - -ns | Nullable<Identifier> | False | - | - -## LifeCycleHTTP +failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - +periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +## ContainerProbeHTTPSpec ### Parents: -- [LifeCycleProbe](#lifecycleprobe) +- [ContainerProbeBaseSpec](#containerprobebasespec) ### Parent types: -- [LifeCycle](#lifecycle) +- [ContainerSpec](#containerspec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- +failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +host | Nullable<Domain> | False | - | - +initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - path | NonEmpty<Path> | False | - | - -port | Positive<NonZero<Integer>> | False | - | - +periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +port | Positive<NonZero<Integer>> | False | <unknown transformation> | - scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - -## PodVolumeItemMapper +successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +## ContainerProbeTCPPortSpec ### Parents: -- [PodVolumeBaseSpec](#podvolumebasespec) -### Children: -- [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) -- [PodVolumeSecretSpec](#podvolumesecretspec) +- [ContainerProbeBaseSpec](#containerprobebasespec) ### Parent types: -- [PodTemplateSpec](#podtemplatespec) +- [ContainerSpec](#containerspec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -item_map | Nullable<Map<String, String>> | False | - | - -name | Identifier | False | - | - -## DaemonSet -### Parents: -- [SelectorsPreProcessMixin](#selectorspreprocessmixin) -### Metadata -Name | Format ----- | ------ -annotations | Map -labels | Map +failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - +periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +port | Positive<NonZero<Integer>> | False | <unknown transformation> | - +successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +## ContainerResourceEachSpec +### Parent types: +- [ContainerResourceSpec](#containerresourcespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -selector | Nullable<[BaseSelector](#baseselector)> | False | <unknown transformation> | - -## DCBaseUpdateStrategy -### Children: +cpu | Nullable<Positive<NonZero<Number>>> | False | <unknown transformation> | - +memory | Nullable<Memory> | False | - | - +## ContainerResourceSpec +### Parent types: +- [ContainerSpec](#containerspec) +- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +- [DCCustomStrategy](#dccustomstrategy) - [DCRecreateStrategy](#dcrecreatestrategy) - [DCRollingStrategy](#dcrollingstrategy) -- [DCCustomStrategy](#dccustomstrategy) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +limits | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - +requests | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - +## ContainerSpec +### Parents: +- [EnvironmentPreProcessMixin](#environmentpreprocessmixin) ### Parent types: -- [DeploymentConfig](#deploymentconfig) +- [PodTemplateSpec](#podtemplatespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -annotations | Map<String, String> | False | - | - -labels | Map<String, String> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - -## Namespace +name | Identifier | True | - | - +args | Nullable<List<String>> | False | - | - +command | Nullable<List<String>> | False | - | - +env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - +image | NonEmpty<String> | False | - | - +imagePullPolicy | Nullable<Enum('Always', 'IfNotPresent')> | False | - | - +kind | Nullable<Enum('DockerImage')> | False | - | - +lifecycle | Nullable<[LifeCycle](#lifecycle)> | False | - | - +livenessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - +ports | Nullable<List<[ContainerPort](#containerport)>> | False | <unknown transformation> | - +readinessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +securityContext | Nullable<[SecurityContext](#securitycontext)> | False | - | - +terminationMessagePath | Nullable<NonEmpty<Path>> | False | - | - +volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | <unknown transformation> | - +## ContainerVolumeMountSpec +### Parent types: +- [ContainerSpec](#containerspec) +- [DCLifecycleNewPod](#dclifecyclenewpod) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | False | - | - +path | NonEmpty<Path> | False | - | - +readOnly | Nullable<Boolean> | False | - | - +## DCBaseUpdateStrategy ### Children: -- [Project](#project) -### Metadata -Name | Format ----- | ------ -annotations | Map -labels | Map +- [DCRecreateStrategy](#dcrecreatestrategy) +- [DCRollingStrategy](#dcrollingstrategy) +- [DCCustomStrategy](#dccustomstrategy) +### Parent types: +- [DeploymentConfig](#deploymentconfig) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -## ContainerEnvSpec +activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +annotations | Map<String, String> | False | - | - +labels | Map<String, String> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +## DCConfigChangeTrigger ### Parents: -- [ContainerEnvBaseSpec](#containerenvbasespec) +- [DCTrigger](#dctrigger) ### Parent types: -- [ContainerSpec](#containerspec) -- [DCCustomParams](#dccustomparams) -- [DCLifecycleNewPod](#dclifecyclenewpod) +- [DeploymentConfig](#deploymentconfig) +## DCCustomParams +### Parents: +- [EnvironmentPreProcessMixin](#environmentpreprocessmixin) +### Parent types: +- [DCCustomStrategy](#dccustomstrategy) +- [DCRecreateStrategy](#dcrecreatestrategy) +- [DCRollingStrategy](#dcrollingstrategy) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | EnvString | False | - | - -value | String | False | - | - -## PodVolumeConfigMapSpec +command | Nullable<List<String>> | False | - | - +environment | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - +image | NonEmpty<String> | False | - | - +## DCCustomStrategy ### Parents: -- [PodVolumeItemMapper](#podvolumeitemmapper) -- [PodVolumeBaseSpec](#podvolumebasespec) +- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) ### Parent types: -- [PodTemplateSpec](#podtemplatespec) +- [DeploymentConfig](#deploymentconfig) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -defaultMode | Nullable<Positive<Integer>> | False | - | - -item_map | Nullable<Map<String, String>> | False | - | - -map_name | Identifier | False | - | - -name | Identifier | False | - | - -## MatchExpression +activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +annotations | Map<String, String> | False | - | - +customParams | [DCCustomParams](#dccustomparams) | False | - | - +labels | Map<String, String> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +## DCImageChangeTrigger +### Parents: +- [DCTrigger](#dctrigger) ### Parent types: -- [MatchExpressionsSelector](#matchexpressionsselector) +- [DeploymentConfig](#deploymentconfig) +## DCLifecycleHook +### Parent types: +- [DCRecreateParams](#dcrecreateparams) +- [DCRollingParams](#dcrollingparams) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -key | NonEmpty<String> | False | - | - -operator | Enum('In', 'NotIn', 'Exists', 'DoesNotExist') | False | - | - -values | Nullable<List<String>> | False | - | - -## SCCSELinux +execNewPod | Nullable<[DCLifecycleNewPod](#dclifecyclenewpod)> | False | - | - +failurePolicy | Enum('Abort', 'Retry', 'Ignore') | False | - | - +tagImages | Nullable<[DCTagImages](#dctagimages)> | False | - | - +## DCLifecycleNewPod +### Parents: +- [EnvironmentPreProcessMixin](#environmentpreprocessmixin) ### Parent types: -- [SecurityContextConstraints](#securitycontextconstraints) +- [DCLifecycleHook](#dclifecyclehook) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -level | Nullable<String> | False | - | - -role | Nullable<String> | False | - | - -strategy | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - -type | Nullable<String> | False | - | - -user | Nullable<String> | False | - | - -## ClusterRoleBinding +command | NonEmpty<List<String>> | False | - | - +containerName | Identifier | False | - | - +env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - +volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | - | - +volumes | Nullable<List<Identifier>> | False | - | - +## DCRecreateParams +### Parent types: +- [DCRecreateStrategy](#dcrecreatestrategy) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +mid | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +## DCRecreateStrategy ### Parents: -- [RoleBindingBase](#rolebindingbase) -- [RoleBindingXF](#rolebindingxf) +- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +### Parent types: +- [DeploymentConfig](#deploymentconfig) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +annotations | Map<String, String> | False | - | - +customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - +labels | Map<String, String> | False | - | - +recreateParams | Nullable<[DCRecreateParams](#dcrecreateparams)> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +## DCRollingParams +### Parent types: +- [DCRollingStrategy](#dcrollingstrategy) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +intervalSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +maxSurge | SurgeSpec | False | - | - +maxUnavailable | SurgeSpec | False | - | - +post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +updatePeriodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +## DCRollingStrategy +### Parents: +- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +### Parent types: +- [DeploymentConfig](#deploymentconfig) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +annotations | Map<String, String> | False | - | - +customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - +labels | Map<String, String> | False | - | - +resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +rollingParams | Nullable<[DCRollingParams](#dcrollingparams)> | False | - | - +## DCTagImages +### Parent types: +- [DCLifecycleHook](#dclifecyclehook) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +containerName | Identifier | False | - | - +toApiVersion | Nullable<String> | False | - | - +toFieldPath | Nullable<String> | False | - | - +toKind | Nullable<Enum('Deployment', 'DeploymentConfig', 'ImageStreamTag')> | False | - | - +toName | Nullable<Identifier> | False | - | - +toNamespace | Nullable<Identifier> | False | - | - +toResourceVersion | Nullable<String> | False | - | - +toUid | Nullable<String> | False | - | - +## DCTrigger +### Children: +- [DCConfigChangeTrigger](#dcconfigchangetrigger) +- [DCImageChangeTrigger](#dcimagechangetrigger) +### Parent types: +- [DeploymentConfig](#deploymentconfig) +## DaemonSet +### Parents: +- [SelectorsPreProcessMixin](#selectorspreprocessmixin) ### Metadata Name | Format ---- | ------ @@ -589,11 +695,57 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - -subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - -## AWSLoadBalancerService +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +selector | Nullable<[BaseSelector](#baseselector)> | False | <unknown transformation> | - +## [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) + + +A Deployment controller provides declarative updates for Pods and ReplicaSets. + +You describe a desired state in a Deployment object, and the Deployment controller changes the actual state to the desired state at a controlled rate. +You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments. + +### Metadata +Name | Format +---- | ------ +annotations | Map +labels | Map +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | True | - | - +minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +paused | Nullable<Boolean> | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +progressDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +replicas | Positive<NonZero<Integer>> | False | - | - +revisionHistoryLimit | Nullable<Positive<NonZero<Integer>>> | False | - | - +selector | Nullable<[BaseSelector](#baseselector)> | False | - | - +strategy | Nullable<[DplBaseUpdateStrategy](#dplbaseupdatestrategy)> | False | - | - +## DeploymentConfig +### Metadata +Name | Format +---- | ------ +annotations | Map +labels | Map +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | True | - | - +minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +paused | Nullable<Boolean> | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +replicas | Positive<NonZero<Integer>> | False | - | - +revisionHistoryLimit | Nullable<Positive<NonZero<Integer>>> | False | - | - +selector | Nullable<Map<String, String>> | False | - | - +strategy | [DCBaseUpdateStrategy](#dcbaseupdatestrategy) | False | - | - +test | Boolean | False | - | - +triggers | List<[DCTrigger](#dctrigger)> | False | - | - +## DockerCredentials ### Parents: -- [Service](#service) +- [Secret](#secret) ### Metadata Name | Format ---- | ------ @@ -604,12 +756,43 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -aws-load-balancer-backend-protocol | Nullable<Identifier> | False | - | - -aws-load-balancer-ssl-cert | Nullable<ARN> | False | - | - -externalTrafficPolicy | Nullable<Enum('Cluster', 'Local')> | False | - | - -ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - -selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - -sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - +dockers | Map<String, Map<String, String>> | False | - | - +secrets | Map<String, String> | False | - | - +type | NonEmpty<String> | False | - | - +## DplBaseUpdateStrategy +### Children: +- [DplRecreateStrategy](#dplrecreatestrategy) +- [DplRollingUpdateStrategy](#dplrollingupdatestrategy) +### Parent types: +- [Deployment](#deployment) +## DplRecreateStrategy +### Parents: +- [DplBaseUpdateStrategy](#dplbaseupdatestrategy) +### Parent types: +- [Deployment](#deployment) +## DplRollingUpdateStrategy +### Parents: +- [DplBaseUpdateStrategy](#dplbaseupdatestrategy) +### Parent types: +- [Deployment](#deployment) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +maxSurge | SurgeSpec | False | - | - +maxUnavailable | SurgeSpec | False | - | - +## Group +### Metadata +Name | Format +---- | ------ +annotations | Map +labels | Map +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | True | - | - +users | NonEmpty<List<UserIdentifier>> | False | - | - ## Job ### Metadata Name | Format @@ -627,92 +810,53 @@ manualSelector | Nullable<Boolean> | False | - | - parallelism | Nullable<Positive<NonZero<Integer>>> | False | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | - | - -## RouteDestService -### Parents: -- [RouteDest](#routedest) -### Parent types: -- [Route](#route) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - -weight | Positive<NonZero<Integer>> | False | - | - -## DCRecreateStrategy -### Parents: -- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +## LifeCycle ### Parent types: -- [DeploymentConfig](#deploymentconfig) +- [ContainerSpec](#containerspec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -annotations | Map<String, String> | False | - | - -customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - -labels | Map<String, String> | False | - | - -recreateParams | Nullable<[DCRecreateParams](#dcrecreateparams)> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - -## DplRollingUpdateStrategy +postStart | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - +preStop | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - +## LifeCycleExec ### Parents: -- [DplBaseUpdateStrategy](#dplbaseupdatestrategy) +- [LifeCycleProbe](#lifecycleprobe) ### Parent types: -- [Deployment](#deployment) +- [LifeCycle](#lifecycle) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -maxSurge | SurgeSpec | False | - | - -maxUnavailable | SurgeSpec | False | - | - -## ContainerSpec +command | NonEmpty<List<String>> | False | - | - +## LifeCycleHTTP ### Parents: -- [EnvironmentPreProcessMixin](#environmentpreprocessmixin) +- [LifeCycleProbe](#lifecycleprobe) ### Parent types: -- [PodTemplateSpec](#podtemplatespec) +- [LifeCycle](#lifecycle) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -args | Nullable<List<String>> | False | - | - -command | Nullable<List<String>> | False | - | - -env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - -image | NonEmpty<String> | False | - | - -imagePullPolicy | Nullable<Enum('Always', 'IfNotPresent')> | False | - | - -kind | Nullable<Enum('DockerImage')> | False | - | - -lifecycle | Nullable<[LifeCycle](#lifecycle)> | False | - | - -livenessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - -ports | Nullable<List<[ContainerPort](#containerport)>> | False | <unknown transformation> | - -readinessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - -securityContext | Nullable<[SecurityContext](#securitycontext)> | False | - | - -terminationMessagePath | Nullable<NonEmpty<Path>> | False | - | - -volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | <unknown transformation> | - -## DplRecreateStrategy -### Parents: -- [DplBaseUpdateStrategy](#dplbaseupdatestrategy) -### Parent types: -- [Deployment](#deployment) -## DCTrigger +path | NonEmpty<Path> | False | - | - +port | Positive<NonZero<Integer>> | False | - | - +scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - +## LifeCycleProbe ### Children: -- [DCConfigChangeTrigger](#dcconfigchangetrigger) -- [DCImageChangeTrigger](#dcimagechangetrigger) +- [LifeCycleExec](#lifecycleexec) +- [LifeCycleHTTP](#lifecyclehttp) ### Parent types: -- [DeploymentConfig](#deploymentconfig) -## ContainerEnvSecretSpec -### Parents: -- [ContainerEnvBaseSpec](#containerenvbasespec) +- [LifeCycle](#lifecycle) +## MatchExpression ### Parent types: -- [ContainerSpec](#containerspec) -- [DCCustomParams](#dccustomparams) -- [DCLifecycleNewPod](#dclifecyclenewpod) +- [MatchExpressionsSelector](#matchexpressionsselector) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- key | NonEmpty<String> | False | - | - -name | EnvString | False | - | - -secret_name | Identifier | False | - | - +operator | Enum('In', 'NotIn', 'Exists', 'DoesNotExist') | False | - | - +values | Nullable<List<String>> | False | - | - ## MatchExpressionsSelector ### Parents: - [BaseSelector](#baseselector) @@ -726,32 +870,22 @@ secret_name | Identifier | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- matchExpressions | NonEmpty<List<[MatchExpression](#matchexpression)>> | False | - | - -## ContainerProbeBaseSpec -### Children: -- [ContainerProbeTCPPortSpec](#containerprobetcpportspec) -- [ContainerProbeHTTPSpec](#containerprobehttpspec) -### Parent types: -- [ContainerSpec](#containerspec) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - -periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -## PodVolumeEmptyDirSpec +## MatchLabelsSelector ### Parents: -- [PodVolumeBaseSpec](#podvolumebasespec) +- [BaseSelector](#baseselector) ### Parent types: -- [PodTemplateSpec](#podtemplatespec) +- [DaemonSet](#daemonset) +- [Deployment](#deployment) +- [Job](#job) +- [PersistentVolumeClaim](#persistentvolumeclaim) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - -## PolicyBinding +matchLabels | Map<String, String> | False | - | - +## Namespace +### Children: +- [Project](#project) ### Metadata Name | Format ---- | ------ @@ -761,9 +895,8 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | ColonIdentifier | True | - | - -roleBindings | List<[PolicyBindingRoleBinding](#policybindingrolebinding)> | False | <unknown transformation> | - -## ConfigMap +name | Identifier | True | - | - +## PersistentVolume ### Metadata Name | Format ---- | ------ @@ -774,40 +907,12 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -files | Map<String, String> | False | - | - -## SCCGroups -### Parent types: -- [SecurityContextConstraints](#securitycontextconstraints) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -ranges | Nullable<List<[SCCGroupRange](#sccgrouprange)>> | False | - | - -type | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - -## DCCustomStrategy -### Parents: -- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) -### Parent types: -- [DeploymentConfig](#deploymentconfig) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -annotations | Map<String, String> | False | - | - -customParams | [DCCustomParams](#dccustomparams) | False | - | - -labels | Map<String, String> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - -## ContainerResourceEachSpec -### Parent types: -- [ContainerResourceSpec](#containerresourcespec) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -cpu | Nullable<Positive<NonZero<Number>>> | False | <unknown transformation> | - -memory | Nullable<Memory> | False | - | - -## StorageClass +accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - +awsElasticBlockStore | Nullable<[AWSElasticBlockStore](#awselasticblockstore)> | False | - | - +capacity | Memory | False | - | - +claimRef | Nullable<[PersistentVolumeRef](#persistentvolumeref)> | False | - | - +persistentVolumeReclaimPolicy | Nullable<Enum('Retain', 'Recycle', 'Delete')> | False | - | - +## PersistentVolumeClaim ### Metadata Name | Format ---- | ------ @@ -818,72 +923,29 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -parameters | Map<String, String> | False | - | - -provisioner | String | False | - | - -## DCRollingParams -### Parent types: -- [DCRollingStrategy](#dcrollingstrategy) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -intervalSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -maxSurge | SurgeSpec | False | - | - -maxUnavailable | SurgeSpec | False | - | - -post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -updatePeriodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -## SCCGroupRange -### Parent types: -- [SCCGroups](#sccgroups) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -max | Positive<NonZero<Integer>> | False | - | - -min | Positive<NonZero<Integer>> | False | - | - -## DCCustomParams -### Parents: -- [EnvironmentPreProcessMixin](#environmentpreprocessmixin) +accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - +request | Memory | False | - | - +selector | Nullable<[BaseSelector](#baseselector)> | False | - | - +volumeName | Nullable<Identifier> | False | <unknown transformation> | - +## PersistentVolumeRef ### Parent types: -- [DCCustomStrategy](#dccustomstrategy) -- [DCRecreateStrategy](#dcrecreatestrategy) -- [DCRollingStrategy](#dcrollingstrategy) +- [PersistentVolume](#persistentvolume) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -command | Nullable<List<String>> | False | - | - -environment | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - -image | NonEmpty<String> | False | - | - -## ContainerVolumeMountSpec +apiVersion | Nullable<String> | False | - | - +kind | Nullable<CaseIdentifier> | False | - | - +name | Nullable<Identifier> | False | - | - +ns | Nullable<Identifier> | False | - | - +## PodImagePullSecret ### Parent types: -- [ContainerSpec](#containerspec) -- [DCLifecycleNewPod](#dclifecyclenewpod) +- [PodTemplateSpec](#podtemplatespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | False | - | - -path | NonEmpty<Path> | False | - | - -readOnly | Nullable<Boolean> | False | - | - -## LifeCycleProbe -### Children: -- [LifeCycleExec](#lifecycleexec) -- [LifeCycleHTTP](#lifecyclehttp) -### Parent types: -- [LifeCycle](#lifecycle) -## SASecretSubject -### Parent types: -- [ServiceAccount](#serviceaccount) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -kind | Nullable<CaseIdentifier> | False | - | - -name | Nullable<Identifier> | False | - | - -ns | Nullable<Identifier> | False | - | - ## PodTemplateSpec ### Parent types: - [DaemonSet](#daemonset) @@ -913,83 +975,96 @@ securityContext | Nullable<[SecurityContext](#securitycontext)> | False | serviceAccountName | Nullable<Identifier> | False | <unknown transformation> | [serviceAccount](#serviceaccount) terminationGracePeriodSeconds | Nullable<Positive<Integer>> | False | - | - volumes | Nullable<List<[PodVolumeBaseSpec](#podvolumebasespec)>> | False | - | - -## User -### Metadata -Name | Format ----- | ------ -annotations | Map -labels | Map +## PodVolumeBaseSpec +### Children: +- [PodVolumeHostSpec](#podvolumehostspec) +- [PodVolumeItemMapper](#podvolumeitemmapper) +- [PodVolumePVCSpec](#podvolumepvcspec) +- [PodVolumeEmptyDirSpec](#podvolumeemptydirspec) +- [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) +- [PodVolumeSecretSpec](#podvolumesecretspec) +### Parent types: +- [PodTemplateSpec](#podtemplatespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | UserIdentifier | True | - | - -fullName | Nullable<String> | False | - | - -identities | NonEmpty<List<NonEmpty<String>>> | False | - | - -## ContainerEnvConfigMapSpec +name | Identifier | False | - | - +## PodVolumeConfigMapSpec ### Parents: -- [ContainerEnvBaseSpec](#containerenvbasespec) +- [PodVolumeItemMapper](#podvolumeitemmapper) +- [PodVolumeBaseSpec](#podvolumebasespec) ### Parent types: -- [ContainerSpec](#containerspec) -- [DCCustomParams](#dccustomparams) -- [DCLifecycleNewPod](#dclifecyclenewpod) +- [PodTemplateSpec](#podtemplatespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -key | NonEmpty<String> | False | - | - +defaultMode | Nullable<Positive<Integer>> | False | - | - +item_map | Nullable<Map<String, String>> | False | - | - map_name | Identifier | False | - | - -name | EnvString | False | - | - -## LifeCycleExec +name | Identifier | False | - | - +## PodVolumeEmptyDirSpec ### Parents: -- [LifeCycleProbe](#lifecycleprobe) +- [PodVolumeBaseSpec](#podvolumebasespec) ### Parent types: -- [LifeCycle](#lifecycle) +- [PodTemplateSpec](#podtemplatespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -command | NonEmpty<List<String>> | False | - | - -## DCRollingStrategy +name | Identifier | False | - | - +## PodVolumeHostSpec ### Parents: -- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) +- [PodVolumeBaseSpec](#podvolumebasespec) +### Parent types: +- [PodTemplateSpec](#podtemplatespec) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +name | Identifier | False | - | - +path | String | False | - | - +## PodVolumeItemMapper +### Parents: +- [PodVolumeBaseSpec](#podvolumebasespec) +### Children: +- [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) +- [PodVolumeSecretSpec](#podvolumesecretspec) ### Parent types: -- [DeploymentConfig](#deploymentconfig) +- [PodTemplateSpec](#podtemplatespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -annotations | Map<String, String> | False | - | - -customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - -labels | Map<String, String> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - -rollingParams | Nullable<[DCRollingParams](#dcrollingparams)> | False | - | - -## RouteDest -### Children: -- [RouteDestService](#routedestservice) +item_map | Nullable<Map<String, String>> | False | - | - +name | Identifier | False | - | - +## PodVolumePVCSpec +### Parents: +- [PodVolumeBaseSpec](#podvolumebasespec) ### Parent types: -- [Route](#route) +- [PodTemplateSpec](#podtemplatespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -weight | Positive<NonZero<Integer>> | False | - | - -## ContainerEnvPodFieldSpec +claimName | Identifier | False | - | - +name | Identifier | False | - | - +## PodVolumeSecretSpec ### Parents: -- [ContainerEnvBaseSpec](#containerenvbasespec) +- [PodVolumeItemMapper](#podvolumeitemmapper) +- [PodVolumeBaseSpec](#podvolumebasespec) ### Parent types: -- [ContainerSpec](#containerspec) -- [DCCustomParams](#dccustomparams) -- [DCLifecycleNewPod](#dclifecyclenewpod) +- [PodTemplateSpec](#podtemplatespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -apiVersion | Nullable<Enum('v1')> | False | - | - -fieldPath | Enum('metadata.name', 'metadata.namespace', 'metadata.labels', 'metadata.annotations', 'spec.nodeName', 'spec.serviceAccountName', 'status.podIP') | False | - | - -name | EnvString | False | - | - -## ServiceAccount +defaultMode | Nullable<Positive<Integer>> | False | - | - +item_map | Nullable<Map<String, String>> | False | - | - +name | Identifier | False | - | - +secret_name | Identifier | False | - | - +## PolicyBinding ### Metadata Name | Format ---- | ------ @@ -999,27 +1074,40 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -imagePullSecrets | Nullable<List<[SAImgPullSecretSubject](#saimgpullsecretsubject)>> | False | <unknown transformation> | - -secrets | Nullable<List<[SASecretSubject](#sasecretsubject)>> | False | <unknown transformation> | - -## PodVolumeBaseSpec -### Children: -- [PodVolumeHostSpec](#podvolumehostspec) -- [PodVolumeItemMapper](#podvolumeitemmapper) -- [PodVolumePVCSpec](#podvolumepvcspec) -- [PodVolumeEmptyDirSpec](#podvolumeemptydirspec) -- [PodVolumeConfigMapSpec](#podvolumeconfigmapspec) -- [PodVolumeSecretSpec](#podvolumesecretspec) +name | ColonIdentifier | True | - | - +roleBindings | List<[PolicyBindingRoleBinding](#policybindingrolebinding)> | False | <unknown transformation> | - +## PolicyBindingRoleBinding +### Parents: +- [RoleBindingXF](#rolebindingxf) ### Parent types: -- [PodTemplateSpec](#podtemplatespec) +- [PolicyBinding](#policybinding) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - -## ClusterRole -### Parents: +metadata | Nullable<Map<String, String>> | False | - | - +name | SystemIdentifier | False | - | - +ns | Identifier | False | - | - +roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - +subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - +## PolicyRule +### Parent types: +- [ClusterRole](#clusterrole) +- [Role](#role) - [RoleBase](#rolebase) +### Properties: + +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +apiGroups | NonEmpty<List<String>> | False | - | - +attributeRestrictions | Nullable<String> | False | - | - +nonResourceURLs | Nullable<List<String>> | False | - | - +resourceNames | Nullable<List<String>> | False | - | - +resources | NonEmpty<List<NonEmpty<String>>> | False | - | - +verbs | NonEmpty<List<Enum('get', 'list', 'create', 'update', 'delete', 'deletecollection', 'watch')>> | False | - | - +## Project +### Parents: +- [Namespace](#namespace) ### Metadata Name | Format ---- | ------ @@ -1030,21 +1118,24 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - -## DCLifecycleHook -### Parent types: -- [DCRecreateParams](#dcrecreateparams) -- [DCRollingParams](#dcrollingparams) +## ReplicationController +### Metadata +Name | Format +---- | ------ +annotations | Map +labels | Map ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -execNewPod | Nullable<[DCLifecycleNewPod](#dclifecyclenewpod)> | False | - | - -failurePolicy | Enum('Abort', 'Retry', 'Ignore') | False | - | - -tagImages | Nullable<[DCTagImages](#dctagimages)> | False | - | - -## ClusterIPService +name | Identifier | True | - | - +minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +replicas | Positive<NonZero<Integer>> | False | - | - +selector | Nullable<Map<String, String>> | False | - | - +## Role ### Parents: -- [Service](#service) +- [RoleBase](#rolebase) ### Metadata Name | Format ---- | ------ @@ -1055,207 +1146,169 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -clusterIP | Nullable<IPv4> | False | - | - -ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - -selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - -sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - -## PersistentVolumeRef -### Parent types: -- [PersistentVolume](#persistentvolume) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -apiVersion | Nullable<String> | False | - | - -kind | Nullable<CaseIdentifier> | False | - | - -name | Nullable<Identifier> | False | - | - -ns | Nullable<Identifier> | False | - | - -## DCLifecycleNewPod +rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - +## RoleBinding ### Parents: -- [EnvironmentPreProcessMixin](#environmentpreprocessmixin) -### Parent types: -- [DCLifecycleHook](#dclifecyclehook) +- [RoleBindingBase](#rolebindingbase) +- [RoleBindingXF](#rolebindingxf) +### Metadata +Name | Format +---- | ------ +annotations | Map +labels | Map ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -command | NonEmpty<List<String>> | False | - | - -containerName | Identifier | False | - | - -env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - -volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | - | - -volumes | Nullable<List<Identifier>> | False | - | - -## ContainerProbeTCPPortSpec -### Parents: -- [ContainerProbeBaseSpec](#containerprobebasespec) +name | SystemIdentifier | True | - | - +roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - +subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - +## RoleRef ### Parent types: -- [ContainerSpec](#containerspec) +- [ClusterRoleBinding](#clusterrolebinding) +- [PolicyBindingRoleBinding](#policybindingrolebinding) +- [RoleBinding](#rolebinding) +- [RoleBindingBase](#rolebindingbase) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - -periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -port | Positive<NonZero<Integer>> | False | <unknown transformation> | - -successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -## ContainerEnvBaseSpec -### Children: -- [ContainerEnvSpec](#containerenvspec) -- [ContainerEnvConfigMapSpec](#containerenvconfigmapspec) -- [ContainerEnvSecretSpec](#containerenvsecretspec) -- [ContainerEnvPodFieldSpec](#containerenvpodfieldspec) -- [ContainerEnvContainerResourceSpec](#containerenvcontainerresourcespec) +name | Nullable<SystemIdentifier> | False | - | - +ns | Nullable<Identifier> | False | - | - +## RoleSubject ### Parent types: -- [ContainerSpec](#containerspec) -- [DCCustomParams](#dccustomparams) -- [DCLifecycleNewPod](#dclifecyclenewpod) +- [ClusterRoleBinding](#clusterrolebinding) +- [PolicyBindingRoleBinding](#policybindingrolebinding) +- [RoleBinding](#rolebinding) +- [RoleBindingBase](#rolebindingbase) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | EnvString | False | - | - -## PodVolumeHostSpec -### Parents: -- [PodVolumeBaseSpec](#podvolumebasespec) -### Parent types: -- [PodTemplateSpec](#podtemplatespec) +kind | CaseIdentifier | False | - | - +name | String | False | - | - +ns | Nullable<Identifier> | False | - | - +## Route +### Metadata +Name | Format +---- | ------ +annotations | Map +labels | Map ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - -path | String | False | - | - -## DCRecreateParams +name | Identifier | True | - | - +host | Domain | False | - | - +port | [RouteDestPort](#routedestport) | False | - | - +tls | Nullable<[RouteTLS](#routetls)> | False | - | - +to | NonEmpty<List<[RouteDest](#routedest)>> | False | - | - +wildcardPolicy | Enum('Subdomain', 'None') | False | - | - +## RouteDest +### Children: +- [RouteDestService](#routedestservice) ### Parent types: -- [DCRecreateStrategy](#dcrecreatestrategy) +- [Route](#route) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -mid | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -## DCTagImages +weight | Positive<NonZero<Integer>> | False | - | - +## RouteDestPort ### Parent types: -- [DCLifecycleHook](#dclifecyclehook) +- [Route](#route) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -containerName | Identifier | False | - | - -toApiVersion | Nullable<String> | False | - | - -toFieldPath | Nullable<String> | False | - | - -toKind | Nullable<Enum('Deployment', 'DeploymentConfig', 'ImageStreamTag')> | False | - | - -toName | Nullable<Identifier> | False | - | - -toNamespace | Nullable<Identifier> | False | - | - -toResourceVersion | Nullable<String> | False | - | - -toUid | Nullable<String> | False | - | - -## Secret -### Children: -- [DockerCredentials](#dockercredentials) -- [TLSCredentials](#tlscredentials) -### Metadata -Name | Format ----- | ------ -annotations | Map -labels | Map +targetPort | Identifier | False | - | - +## RouteDestService +### Parents: +- [RouteDest](#routedest) +### Parent types: +- [Route](#route) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -secrets | Map<String, String> | False | - | - -type | NonEmpty<String> | False | - | - -## RouteDestPort +name | Identifier | False | - | - +weight | Positive<NonZero<Integer>> | False | - | - +## RouteTLS ### Parent types: - [Route](#route) ### Properties: -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -targetPort | Identifier | False | - | - -## BaseSelector -### Children: -- [MatchLabelsSelector](#matchlabelsselector) -- [MatchExpressionsSelector](#matchexpressionsselector) -### Parent types: -- [DaemonSet](#daemonset) -- [Deployment](#deployment) -- [Job](#job) -- [PersistentVolumeClaim](#persistentvolumeclaim) -## ContainerProbeHTTPSpec -### Parents: -- [ContainerProbeBaseSpec](#containerprobebasespec) +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +caCertificate | Nullable<NonEmpty<String>> | False | - | - +certificate | Nullable<NonEmpty<String>> | False | - | - +destinationCACertificate | Nullable<NonEmpty<String>> | False | - | - +insecureEdgeTerminationPolicy | Enum('Allow', 'Disable', 'Redirect') | False | - | - +key | Nullable<NonEmpty<String>> | False | - | - +termination | Enum('edge', 'reencrypt', 'passthrough') | False | - | - +## SAImgPullSecretSubject ### Parent types: -- [ContainerSpec](#containerspec) +- [ServiceAccount](#serviceaccount) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -host | Nullable<Domain> | False | - | - -initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - -path | NonEmpty<Path> | False | - | - -periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -port | Positive<NonZero<Integer>> | False | <unknown transformation> | - -scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - -successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -## ServicePort +name | Identifier | False | - | - +## SASecretSubject ### Parent types: -- [AWSLoadBalancerService](#awsloadbalancerservice) -- [ClusterIPService](#clusteripservice) -- [Service](#service) +- [ServiceAccount](#serviceaccount) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- +kind | Nullable<CaseIdentifier> | False | - | - name | Nullable<Identifier> | False | - | - -port | Positive<NonZero<Integer>> | False | - | - -protocol | Enum('TCP', 'UDP') | False | - | - -targetPort | OneOf<Positive<NonZero<Integer>>, Identifier> | False | - | - -## AWSElasticBlockStore +ns | Nullable<Identifier> | False | - | - +## SCCGroupRange ### Parent types: -- [PersistentVolume](#persistentvolume) +- [SCCGroups](#sccgroups) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -fsType | Enum('ext4') | False | - | - -volumeID | AWSVolID | False | - | - -## ReplicationController -### Metadata -Name | Format ----- | ------ -annotations | Map -labels | Map +max | Positive<NonZero<Integer>> | False | - | - +min | Positive<NonZero<Integer>> | False | - | - +## SCCGroups +### Parent types: +- [SecurityContextConstraints](#securitycontextconstraints) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -replicas | Positive<NonZero<Integer>> | False | - | - -selector | Nullable<Map<String, String>> | False | - | - -## SAImgPullSecretSubject +ranges | Nullable<List<[SCCGroupRange](#sccgrouprange)>> | False | - | - +type | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - +## SCCRunAsUser ### Parent types: -- [ServiceAccount](#serviceaccount) +- [SecurityContextConstraints](#securitycontextconstraints) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - -## [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) - - -A Deployment controller provides declarative updates for Pods and ReplicaSets. - -You describe a desired state in a Deployment object, and the Deployment controller changes the actual state to the desired state at a controlled rate. -You can define Deployments to create new ReplicaSets, or to remove existing Deployments and adopt all their resources with new Deployments. +type | Enum('MustRunAs', 'RunAsAny', 'MustRunAsRange', 'MustRunAsNonRoot') | False | - | - +uid | Nullable<Positive<NonZero<Integer>>> | False | - | - +uidRangeMax | Nullable<Positive<NonZero<Integer>>> | False | - | - +uidRangeMin | Nullable<Positive<NonZero<Integer>>> | False | - | - +## SCCSELinux +### Parent types: +- [SecurityContextConstraints](#securitycontextconstraints) +### Properties: +Name | Type | Identifier | Type Transformation | Aliases +---- | ---- | ---------- | ------------------- | ------- +level | Nullable<String> | False | - | - +role | Nullable<String> | False | - | - +strategy | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - +type | Nullable<String> | False | - | - +user | Nullable<String> | False | - | - +## Secret +### Children: +- [DockerCredentials](#dockercredentials) +- [TLSCredentials](#tlscredentials) ### Metadata Name | Format ---- | ------ @@ -1266,35 +1319,21 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -paused | Nullable<Boolean> | False | - | - -pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -progressDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -replicas | Positive<NonZero<Integer>> | False | - | - -revisionHistoryLimit | Nullable<Positive<NonZero<Integer>>> | False | - | - -selector | Nullable<[BaseSelector](#baseselector)> | False | - | - -strategy | Nullable<[DplBaseUpdateStrategy](#dplbaseupdatestrategy)> | False | - | - -## PodImagePullSecret +secrets | Map<String, String> | False | - | - +type | NonEmpty<String> | False | - | - +## SecurityContext ### Parent types: +- [ContainerSpec](#containerspec) - [PodTemplateSpec](#podtemplatespec) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - -## RoleSubject -### Parent types: -- [ClusterRoleBinding](#clusterrolebinding) -- [PolicyBindingRoleBinding](#policybindingrolebinding) -- [RoleBinding](#rolebinding) -- [RoleBindingBase](#rolebindingbase) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -kind | CaseIdentifier | False | - | - -name | String | False | - | - -ns | Nullable<Identifier> | False | - | - +fsGroup | Nullable<Integer> | False | - | - +privileged | Nullable<Boolean> | False | - | - +runAsNonRoot | Nullable<Boolean> | False | - | - +runAsUser | Nullable<Integer> | False | - | - +supplementalGroups | Nullable<List<Integer>> | False | - | - ## SecurityContextConstraints ### Metadata Name | Format @@ -1325,7 +1364,10 @@ seccompProfiles | Nullable<List<String>> | False | - | - supplementalGroups | Nullable<[SCCGroups](#sccgroups)> | False | - | - users | List<SystemIdentifier> | False | - | - volumes | List<Enum('configMap', 'downwardAPI', 'emptyDir', 'hostPath', 'nfs', 'persistentVolumeClaim', 'secret', '*')> | False | - | - -## Route +## Service +### Children: +- [ClusterIPService](#clusteripservice) +- [AWSLoadBalancerService](#awsloadbalancerservice) ### Metadata Name | Format ---- | ------ @@ -1336,51 +1378,10 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | Identifier | True | - | - -host | Domain | False | - | - -port | [RouteDestPort](#routedestport) | False | - | - -tls | Nullable<[RouteTLS](#routetls)> | False | - | - -to | NonEmpty<List<[RouteDest](#routedest)>> | False | - | - -wildcardPolicy | Enum('Subdomain', 'None') | False | - | - -## ContainerResourceSpec -### Parent types: -- [ContainerSpec](#containerspec) -- [DCBaseUpdateStrategy](#dcbaseupdatestrategy) -- [DCCustomStrategy](#dccustomstrategy) -- [DCRecreateStrategy](#dcrecreatestrategy) -- [DCRollingStrategy](#dcrollingstrategy) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -limits | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - -requests | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - -## PolicyBindingRoleBinding -### Parents: -- [RoleBindingXF](#rolebindingxf) -### Parent types: -- [PolicyBinding](#policybinding) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -metadata | Nullable<Map<String, String>> | False | - | - -name | SystemIdentifier | False | - | - -ns | Identifier | False | - | - -roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - -subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - -## LifeCycle -### Parent types: -- [ContainerSpec](#containerspec) -### Properties: - -Name | Type | Identifier | Type Transformation | Aliases ----- | ---- | ---------- | ------------------- | ------- -postStart | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - -preStop | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - -## RoleBinding -### Parents: -- [RoleBindingBase](#rolebindingbase) -- [RoleBindingXF](#rolebindingxf) +ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - +selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - +sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - +## ServiceAccount ### Metadata Name | Format ---- | ------ @@ -1390,63 +1391,62 @@ labels | Map Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | SystemIdentifier | True | - | - -roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - -subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - -## MatchLabelsSelector -### Parents: -- [BaseSelector](#baseselector) +name | Identifier | True | - | - +imagePullSecrets | Nullable<List<[SAImgPullSecretSubject](#saimgpullsecretsubject)>> | False | <unknown transformation> | - +secrets | Nullable<List<[SASecretSubject](#sasecretsubject)>> | False | <unknown transformation> | - +## ServicePort ### Parent types: -- [DaemonSet](#daemonset) -- [Deployment](#deployment) -- [Job](#job) -- [PersistentVolumeClaim](#persistentvolumeclaim) +- [AWSLoadBalancerService](#awsloadbalancerservice) +- [ClusterIPService](#clusteripservice) +- [Service](#service) ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -matchLabels | Map<String, String> | False | - | - -## PolicyRule -### Parent types: -- [ClusterRole](#clusterrole) -- [Role](#role) -- [RoleBase](#rolebase) +name | Nullable<Identifier> | False | - | - +port | Positive<NonZero<Integer>> | False | - | - +protocol | Enum('TCP', 'UDP') | False | - | - +targetPort | OneOf<Positive<NonZero<Integer>>, Identifier> | False | - | - +## StorageClass +### Metadata +Name | Format +---- | ------ +annotations | Map +labels | Map ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -apiGroups | NonEmpty<List<String>> | False | - | - -attributeRestrictions | Nullable<String> | False | - | - -nonResourceURLs | Nullable<List<String>> | False | - | - -resourceNames | Nullable<List<String>> | False | - | - -resources | NonEmpty<List<NonEmpty<String>>> | False | - | - -verbs | NonEmpty<List<Enum('get', 'list', 'create', 'update', 'delete', 'deletecollection', 'watch')>> | False | - | - -## ContainerEnvContainerResourceSpec +name | Identifier | True | - | - +parameters | Map<String, String> | False | - | - +provisioner | String | False | - | - +## TLSCredentials ### Parents: -- [ContainerEnvBaseSpec](#containerenvbasespec) -### Parent types: -- [ContainerSpec](#containerspec) -- [DCCustomParams](#dccustomparams) -- [DCLifecycleNewPod](#dclifecyclenewpod) +- [Secret](#secret) +### Metadata +Name | Format +---- | ------ +annotations | Map +labels | Map ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -containerName | Nullable<Identifier> | False | - | - -divisor | Nullable<NonEmpty<String>> | False | - | - -name | EnvString | False | - | - -resource | Enum('limits.cpu', 'limits.memory', 'requests.cpu', 'requests.memory') | False | - | - -## PodVolumeSecretSpec -### Parents: -- [PodVolumeItemMapper](#podvolumeitemmapper) -- [PodVolumeBaseSpec](#podvolumebasespec) -### Parent types: -- [PodTemplateSpec](#podtemplatespec) +name | Identifier | True | - | - +secrets | Map<String, String> | False | - | - +tls_cert | String | False | - | - +tls_key | String | False | - | - +type | NonEmpty<String> | False | - | - +## User +### Metadata +Name | Format +---- | ------ +annotations | Map +labels | Map ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -defaultMode | Nullable<Positive<Integer>> | False | - | - -item_map | Nullable<Map<String, String>> | False | - | - -name | Identifier | False | - | - -secret_name | Identifier | False | - | - +name | UserIdentifier | True | - | - +fullName | Nullable<String> | False | - | - +identities | NonEmpty<List<NonEmpty<String>>> | False | - | - diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index eb33af6..d819cdd 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -35,14 +35,14 @@ def run(self, args): header += '- [Formats](#formats)\n' md += '\n# Formats\n\n' - for fname in formats.keys(): + for fname in sorted(formats.keys()): header += ' - [{}](#{})\n'.format(fname, fname.lower()) md += '## {}\n\n'.format(fname) md += '{}\n\n'.format(formats[fname].get_description()) header += '- [Types](#types)\n' md += '\n# Types\n\n' - for tname in types.keys(): + for tname in sorted(types.keys()): header += ' - [{}](#{})\n'.format(tname, tname.lower()) md += '## {}\n\n'.format(tname) md += '{}\n\n'.format(types[tname].get_description()) @@ -50,7 +50,7 @@ def run(self, args): header += '- [Objects](#objects)\n' md += '\n# Objects\n\n' - for oname in objs.keys(): + for oname in sorted(objs.keys()): header += ' - [{}](#{})\n'.format(oname, oname.lower()) md += objs[oname].get_help().render_markdown() From 6e965e1f1f4062c41e786c37f1a6a595373965a2 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 15:57:00 +0200 Subject: [PATCH 17/40] Added example on ARN class --- docs/rubiks.class.md | 24 ++++++++++++++++++++++-- lib/commands/docgen.py | 4 ++-- lib/kube_types.py | 24 ++++++++++++++++++++++++ 3 files changed, 48 insertions(+), 4 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index d1d43f2..a09c3e6 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -153,8 +153,28 @@ Stay tuned to have more hint about this variable. ## ARN -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +Amazon Resource Names (ARNs) uniquely identify AWS resources. + +The following are the general formats for ARNs; the specific components and values used depend on the AWS service. + +``` +arn:partition:service:region:account-id:resource +arn:partition:service:region:account-id:resourcetype/resource +arn:partition:service:region:account-id:resourcetype:resource +``` + +*partition* +The partition that the resource is in. For standard AWS regions, the partition is aws. If you have resources in other partitions, the partition is aws-partitionname. For example, the partition for resources in the China (Beijing) region is aws-cn. +*service* +The service namespace that identifies the AWS product (for example, Amazon S3, IAM, or Amazon RDS). For a list of namespaces, see AWS Service Namespaces. +*region* +The region the resource resides in. Note that the ARNs for some resources do not require a region, so this component might be omitted. +*account* +The ID of the AWS account that owns the resource, without the hyphens. For example, 123456789012. Note that the ARNs for some resources don't require an account number, so this component might be omitted. +*resource, resourcetype:resource, or resourcetype/resource* +The content of this part of the ARN varies by service. It often includes an indicator of the type of resource—for example, an IAM user or Amazon RDS database —followed by a slash (/) or a colon (:), followed by the resource name itself. Some services allow paths for resource names, as described in Paths in ARNs. + ## Boolean diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index d819cdd..e4bf1fc 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -55,5 +55,5 @@ def run(self, args): md += objs[oname].get_help().render_markdown() with open(os.path.join(r.basepath, 'docs/rubiks.class.md'), 'w') as f: - f.write(header) - f.write(md) \ No newline at end of file + f.write(header.encode('utf-8')) + f.write(md.encode('utf-8')) \ No newline at end of file diff --git a/lib/kube_types.py b/lib/kube_types.py index d6f2e4d..12d6c05 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -1,4 +1,5 @@ # (c) Copyright 2017-2018 OLX +# -*- coding: utf-8 -*- from __future__ import absolute_import from __future__ import division @@ -352,6 +353,29 @@ def do_check(self, value, path): class ARN(String): + """ + Amazon Resource Names (ARNs) uniquely identify AWS resources. + + The following are the general formats for ARNs; the specific components and values used depend on the AWS service. + + ``` + arn:partition:service:region:account-id:resource + arn:partition:service:region:account-id:resourcetype/resource + arn:partition:service:region:account-id:resourcetype:resource + ``` + + *partition* + The partition that the resource is in. For standard AWS regions, the partition is aws. If you have resources in other partitions, the partition is aws-partitionname. For example, the partition for resources in the China (Beijing) region is aws-cn. + *service* + The service namespace that identifies the AWS product (for example, Amazon S3, IAM, or Amazon RDS). For a list of namespaces, see AWS Service Namespaces. + *region* + The region the resource resides in. Note that the ARNs for some resources do not require a region, so this component might be omitted. + *account* + The ID of the AWS account that owns the resource, without the hyphens. For example, 123456789012. Note that the ARNs for some resources don't require an account number, so this component might be omitted. + *resource, resourcetype:resource, or resourcetype/resource* + The content of this part of the ARN varies by service. It often includes an indicator of the type of resource—for example, an IAM user or Amazon RDS database —followed by a slash (/) or a colon (:), followed by the resource name itself. Some services allow paths for resource names, as described in Paths in ARNs. + """ + validation_text = "Amazon ARNs start with arn:aws:..." def do_check(self, value, path): From 10d8ce05b91a407c8c9225ce23b2e7ffc620c147 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 15:59:19 +0200 Subject: [PATCH 18/40] Fixed md --- docs/rubiks.class.md | 19 ++++++++++++++----- lib/kube_types.py | 19 ++++++++++++++----- 2 files changed, 28 insertions(+), 10 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index a09c3e6..899fc22 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -164,15 +164,24 @@ arn:partition:service:region:account-id:resourcetype/resource arn:partition:service:region:account-id:resourcetype:resource ``` -*partition* +**partition** + The partition that the resource is in. For standard AWS regions, the partition is aws. If you have resources in other partitions, the partition is aws-partitionname. For example, the partition for resources in the China (Beijing) region is aws-cn. -*service* + +**service** + The service namespace that identifies the AWS product (for example, Amazon S3, IAM, or Amazon RDS). For a list of namespaces, see AWS Service Namespaces. -*region* + +**region** + The region the resource resides in. Note that the ARNs for some resources do not require a region, so this component might be omitted. -*account* + +**account** + The ID of the AWS account that owns the resource, without the hyphens. For example, 123456789012. Note that the ARNs for some resources don't require an account number, so this component might be omitted. -*resource, resourcetype:resource, or resourcetype/resource* + +**resource, resourcetype:resource, or resourcetype/resource** + The content of this part of the ARN varies by service. It often includes an indicator of the type of resource—for example, an IAM user or Amazon RDS database —followed by a slash (/) or a colon (:), followed by the resource name itself. Some services allow paths for resource names, as described in Paths in ARNs. diff --git a/lib/kube_types.py b/lib/kube_types.py index 12d6c05..d538090 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -364,15 +364,24 @@ class ARN(String): arn:partition:service:region:account-id:resourcetype:resource ``` - *partition* + **partition** + The partition that the resource is in. For standard AWS regions, the partition is aws. If you have resources in other partitions, the partition is aws-partitionname. For example, the partition for resources in the China (Beijing) region is aws-cn. - *service* + + **service** + The service namespace that identifies the AWS product (for example, Amazon S3, IAM, or Amazon RDS). For a list of namespaces, see AWS Service Namespaces. - *region* + + **region** + The region the resource resides in. Note that the ARNs for some resources do not require a region, so this component might be omitted. - *account* + + **account** + The ID of the AWS account that owns the resource, without the hyphens. For example, 123456789012. Note that the ARNs for some resources don't require an account number, so this component might be omitted. - *resource, resourcetype:resource, or resourcetype/resource* + + **resource, resourcetype:resource, or resourcetype/resource** + The content of this part of the ARN varies by service. It often includes an indicator of the type of resource—for example, an IAM user or Amazon RDS database —followed by a slash (/) or a colon (:), followed by the resource name itself. Some services allow paths for resource names, as described in Paths in ARNs. """ From 48ef2f77166c1dc471c3d2deef108074a29ae29b Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 16:07:55 +0200 Subject: [PATCH 19/40] Added more test details --- docs/rubiks.class.md | 26 ++++++++++++++++++-------- lib/kube_types.py | 25 +++++++++++++++++++++++++ 2 files changed, 43 insertions(+), 8 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 899fc22..b213f09 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -187,8 +187,10 @@ The content of this part of the ARN varies by service. It often includes an indi ## Boolean -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +Boolean, or boolean logic, is a subset of algebra used for creating true/false statements. +Boolean expressions use the operators AND, OR, XOR, and NOT to compare values and return a true or false result. + ## CaseIdentifier @@ -207,8 +209,13 @@ Stay tuned to have more hint about this variable. ## Enum -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +Enum, short for "enumerated," is a data type that consists of predefined values. A constant or variable defined as an enum can store one of the values listed in the enum declaration. + +**Example*** + +`Enum('Value1', 'Value2', 'Value3')` + ## IP @@ -227,13 +234,16 @@ Stay tuned to have more hint about this variable. ## Integer -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +An integer is a whole number (not a fraction) that can be positive, negative, or zero. +Therefore, the numbers 10, 0, -25, and 5,148 are all integers. Unlike floating point numbers, integers cannot have decimal places. + ## Number -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +An integer is a whole number (not a fraction) that can be positive, negative, floating or zero. + ## Path diff --git a/lib/kube_types.py b/lib/kube_types.py index d538090..b29aeae 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -122,6 +122,10 @@ def do_check(self, value, path): class Boolean(KubeType): + """ + Boolean, or boolean logic, is a subset of algebra used for creating true/false statements. + Boolean expressions use the operators AND, OR, XOR, and NOT to compare values and return a true or false result. + """ validation_text = "Expected boolean" def do_check(self, value, path): @@ -129,6 +133,13 @@ def do_check(self, value, path): class Enum(KubeType): + """ + Enum, short for "enumerated," is a data type that consists of predefined values. A constant or variable defined as an enum can store one of the values listed in the enum declaration. + + **Example*** + + `Enum('Value1', 'Value2', 'Value3')` + """ def __init__(self, *args): self.enums = args @@ -145,6 +156,10 @@ def do_check(self, value, path): class Integer(KubeType): + """ + An integer is a whole number (not a fraction) that can be positive, negative, or zero. + Therefore, the numbers 10, 0, -25, and 5,148 are all integers. Unlike floating point numbers, integers cannot have decimal places. + """ validation_text = "Expected integer" def do_check(self, value, path): @@ -156,6 +171,9 @@ def do_check(self, value, path): class Number(KubeType): + """ + An integer is a whole number (not a fraction) that can be positive, negative, floating or zero. + """ validation_text = "Expected number" def do_check(self, value, path): @@ -167,6 +185,9 @@ def do_check(self, value, path): class Positive(KubeType): + """ + Define a number that needs to be positive (0 is included as positive) + """ validation_text = "Expected positive" wrapper = True @@ -175,6 +196,10 @@ def do_check(self, value, path): class NonZero(KubeType): + """ + Represent any number that is not 0. + Will be accepted positive and negative of any kind. + """ validation_text = "Expected non-zero" wrapper = True From d915f01a93a6d1c12855d098a859e22e40cbb03c Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 16:10:11 +0200 Subject: [PATCH 20/40] Fixed typo on markdown --- docs/rubiks.class.md | 2 +- lib/kube_types.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index b213f09..62c6a5c 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -212,7 +212,7 @@ Stay tuned to have more hint about this variable. Enum, short for "enumerated," is a data type that consists of predefined values. A constant or variable defined as an enum can store one of the values listed in the enum declaration. -**Example*** +**Example** `Enum('Value1', 'Value2', 'Value3')` diff --git a/lib/kube_types.py b/lib/kube_types.py index b29aeae..69aed88 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -136,7 +136,7 @@ class Enum(KubeType): """ Enum, short for "enumerated," is a data type that consists of predefined values. A constant or variable defined as an enum can store one of the values listed in the enum declaration. - **Example*** + **Example** `Enum('Value1', 'Value2', 'Value3')` """ From 2a45edac9fa7802161fe7470732532c7985562e3 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 21:16:44 +0200 Subject: [PATCH 21/40] Other fix testing the links generation --- lib/commands/docgen.py | 5 ++++- lib/kube_help.py | 13 +++++++++++-- lib/kube_types.py | 11 +++++++++++ lib/load_python.py | 2 +- 4 files changed, 27 insertions(+), 4 deletions(-) diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index e4bf1fc..0c1dfb6 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -24,6 +24,9 @@ def run(self, args): objs = load_python.PythonBaseFile.get_kube_objs() types = load_python.PythonBaseFile.get_kube_types() formats = load_python.PythonBaseFile.get_kube_vartypes() + + additional_links = types.keys() + formats.keys() + print(additional_links) r = self.get_repository() @@ -52,7 +55,7 @@ def run(self, args): md += '\n# Objects\n\n' for oname in sorted(objs.keys()): header += ' - [{}](#{})\n'.format(oname, oname.lower()) - md += objs[oname].get_help().render_markdown() + md += objs[oname].get_help().render_markdown(links=additional_links) with open(os.path.join(r.basepath, 'docs/rubiks.class.md'), 'w') as f: f.write(header.encode('utf-8')) diff --git a/lib/kube_help.py b/lib/kube_help.py index adaaa47..6bfc5a4 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -118,7 +118,15 @@ def _get_markdown_link(self, objects): def _docstring_formatter(self): return '\n'.join([line.strip() for line in self.class_doc.split('\n')]) - def render_markdown(self): + def _decorate_obj_links(self, display, links): + print(display) + for link in links: + display = display.replace(link, self._get_markdown_link(link)) + print(display) + + return display + + def render_markdown(self, links=[]): # Title generation based on link if self.class_doc_link is not None: txt = '## [{}]({})\n'.format(self.class_name, self.class_doc_link) @@ -184,7 +192,8 @@ def render_markdown(self): elif isinstance(original_type, dict): original_type = original_type['value'] classname = original_type.__name__ - display_type = display_type.replace(classname, self._get_markdown_link(classname)) + display_type = self._decorate_obj_links(display=display_type, links=(links + [classname])) + # display_type = display_type.replace(classname, self._get_markdown_link(classname)) txt += '{} | {} | False | {} | {} \n'.format(p, display_type, xf_data, is_mapped) diff --git a/lib/kube_types.py b/lib/kube_types.py index 69aed88..2f15d1a 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -492,6 +492,17 @@ def do_check(self, value, path): class Map(KubeType): + """ + Enforce a Map to be composed by pre-defined types specified on the initialization. + + **Esample:** + + `Map(String, String)` + `Map(Int, String)` + `Map(Int, Int)` + + This will allow to perform some authomatic checks inside the imput of an Object + """ def __init__(self, key, value): self.key = self.__class__.construct_arg(key) self.value = self.__class__.construct_arg(value) diff --git a/lib/load_python.py b/lib/load_python.py index a699865..adffa64 100644 --- a/lib/load_python.py +++ b/lib/load_python.py @@ -250,7 +250,7 @@ def get_kube_types(cls): cls._kube_type = {} for k in kube_types.__dict__: - if isinstance(kube_types.__dict__[k], type) and k not in ('KubeType'): + if isinstance(kube_types.__dict__[k], type) and k not in ('KubeType', 'Object'): try: if isinstance(kube_objs.__dict__[k](), KubeType): cls._kube_type[k] = kube_types.__dict__[k] From 5fc88dad78def0c5c27851ded1c15bdd1ff44b6c Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 21:26:46 +0200 Subject: [PATCH 22/40] Added more links --- docs/rubiks.class.md | 112 ++++++++++++++++++++--------------------- lib/commands/docgen.py | 1 - lib/kube_help.py | 7 ++- 3 files changed, 59 insertions(+), 61 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 62c6a5c..c205a2b 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -283,8 +283,8 @@ volumeID | AWSVolID | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -311,8 +311,8 @@ sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -328,8 +328,8 @@ sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -343,8 +343,8 @@ rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -356,8 +356,8 @@ subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | < ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -727,8 +727,8 @@ toUid | Nullable<String> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -747,8 +747,8 @@ You can define Deployments to create new ReplicaSets, or to remove existing Depl ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -766,8 +766,8 @@ strategy | Nullable<[DplBaseUpdateStrategy](#dplbaseupdatestrategy)> | Fal ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -788,8 +788,8 @@ triggers | List<[DCTrigger](#dctrigger)> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -824,8 +824,8 @@ maxUnavailable | SurgeSpec | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -836,8 +836,8 @@ users | NonEmpty<List<UserIdentifier>> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -928,8 +928,8 @@ matchLabels | Map<String, String> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -939,8 +939,8 @@ name | Identifier | True | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -955,8 +955,8 @@ persistentVolumeReclaimPolicy | Nullable<Enum('Retain', 'Recycle', 'Delete')& ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -995,8 +995,8 @@ name | Identifier | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1107,8 +1107,8 @@ secret_name | Identifier | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1150,8 +1150,8 @@ verbs | NonEmpty<List<Enum('get', 'list', 'create', 'update', 'delete', 'd ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1161,8 +1161,8 @@ name | Identifier | True | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1178,8 +1178,8 @@ selector | Nullable<Map<String, String>> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1193,8 +1193,8 @@ rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1231,8 +1231,8 @@ ns | Nullable<Identifier> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1351,8 +1351,8 @@ user | Nullable<String> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1377,8 +1377,8 @@ supplementalGroups | Nullable<List<Integer>> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1410,8 +1410,8 @@ volumes | List<Enum('configMap', 'downwardAPI', 'emptyDir', 'hostPath', 'nfs' ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1424,8 +1424,8 @@ sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1450,8 +1450,8 @@ targetPort | OneOf<Positive<NonZero<Integer>>, Identifier> | F ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1465,8 +1465,8 @@ provisioner | String | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1480,8 +1480,8 @@ type | NonEmpty<String> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map -labels | Map +annotations | Map<[String](#string), [String](#string)> +labels | Map<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index 0c1dfb6..3dafabf 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -26,7 +26,6 @@ def run(self, args): formats = load_python.PythonBaseFile.get_kube_vartypes() additional_links = types.keys() + formats.keys() - print(additional_links) r = self.get_repository() diff --git a/lib/kube_help.py b/lib/kube_help.py index 6bfc5a4..1b987c9 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -119,10 +119,8 @@ def _docstring_formatter(self): return '\n'.join([line.strip() for line in self.class_doc.split('\n')]) def _decorate_obj_links(self, display, links): - print(display) for link in links: display = display.replace(link, self._get_markdown_link(link)) - print(display) return display @@ -160,8 +158,8 @@ def render_markdown(self, links=[]): txt += '### Metadata\n' txt += 'Name | Format\n' txt += '---- | ------\n' - txt += 'annotations | {}\n'.format(Map(String, String).name()) - txt += 'labels | {}\n'.format(Map(String, String).name()) + txt += 'annotations | {}\n'.format(self._decorate_obj_links(Map(String, String).name(), links)) + txt += 'labels | {}\n'.format(self._decorate_obj_links(Map(String, String).name(), links)) # Properties table if len(self.class_types.keys()) == 0: @@ -180,6 +178,7 @@ def render_markdown(self, links=[]): # Prepare Type transformation and remove special character that could ruin visualization in markdown xf_data = self.class_xf_detail[p] if p in self.class_xf_detail else '-' xf_data = xf_data.replace('<', '<').replace('>', '>') + xf_data = self._decorate_obj_links(display=xf_data, links=links) is_mapped = ', '.join(self._get_markdown_link(self.class_mapping[p])) if p in self.class_mapping else '-' From 2c380110966ddacc9550a7138432eaa7ce35a42c Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Sun, 8 Jul 2018 23:30:47 +0200 Subject: [PATCH 23/40] Added new identifier --- docs/rubiks.class.md | 530 +++++++++++++++++++++---------------------- lib/kube_help.py | 6 +- lib/load_python.py | 2 +- 3 files changed, 269 insertions(+), 269 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index c205a2b..698854a 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -275,7 +275,7 @@ Stay tuned to have more hint about this variable. Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -fsType | Enum('ext4') | False | - | - +fsType | [Enum](#enum)('ext4') | False | - | - volumeID | AWSVolID | False | - | - ## AWSLoadBalancerService ### Parents: @@ -289,13 +289,13 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -aws-load-balancer-backend-protocol | Nullable<Identifier> | False | - | - -aws-load-balancer-ssl-cert | Nullable<ARN> | False | - | - -externalTrafficPolicy | Nullable<Enum('Cluster', 'Local')> | False | - | - +name | [Identifier](#identifier) | True | - | - +aws-load-balancer-backend-protocol | Nullable<[Identifier](#identifier)> | False | - | - +aws-load-balancer-ssl-cert | Nullable<[ARN](#arn)> | False | - | - +externalTrafficPolicy | Nullable<[Enum](#enum)('Cluster', 'Local')> | False | - | - ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - -selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - -sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - +selector | NonEmpty<Map<[String](#string), [String](#string)>> | False | <unknown transformation> | - +sessionAffinity | Nullable<[Enum](#enum)('Client[IP](#ip)', 'None')> | False | - | - ## BaseSelector ### Children: - [MatchLabelsSelector](#matchlabelsselector) @@ -317,11 +317,11 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -clusterIP | Nullable<IPv4> | False | - | - +name | [Identifier](#identifier) | True | - | - +clusterIP | Nullable<[IP](#ip)v4> | False | - | - ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - -selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - -sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - +selector | NonEmpty<Map<[String](#string), [String](#string)>> | False | <unknown transformation> | - +sessionAffinity | Nullable<[Enum](#enum)('Client[IP](#ip)', 'None')> | False | - | - ## ClusterRole ### Parents: - [RoleBase](#rolebase) @@ -334,7 +334,7 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - +name | [Identifier](#identifier) | True | - | - rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ## ClusterRoleBinding ### Parents: @@ -349,7 +349,7 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - +name | [Identifier](#identifier) | True | - | - roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## ConfigMap @@ -362,8 +362,8 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -files | Map<String, String> | False | - | - +name | [Identifier](#identifier) | True | - | - +files | Map<[String](#string), [String](#string)> | False | - | - ## ContainerEnvBaseSpec ### Children: - [ContainerEnvSpec](#containerenvspec) @@ -379,7 +379,7 @@ files | Map<String, String> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | EnvString | False | - | - +name | Env[String](#string) | False | - | - ## ContainerEnvConfigMapSpec ### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -391,9 +391,9 @@ name | EnvString | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -key | NonEmpty<String> | False | - | - -map_name | Identifier | False | - | - -name | EnvString | False | - | - +key | NonEmpty<[String](#string)> | False | - | - +map_name | [Identifier](#identifier) | False | - | - +name | Env[String](#string) | False | - | - ## ContainerEnvContainerResourceSpec ### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -405,10 +405,10 @@ name | EnvString | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -containerName | Nullable<Identifier> | False | - | - -divisor | Nullable<NonEmpty<String>> | False | - | - -name | EnvString | False | - | - -resource | Enum('limits.cpu', 'limits.memory', 'requests.cpu', 'requests.memory') | False | - | - +containerName | Nullable<[Identifier](#identifier)> | False | - | - +divisor | Nullable<NonEmpty<[String](#string)>> | False | - | - +name | Env[String](#string) | False | - | - +resource | [Enum](#enum)('limits.cpu', 'limits.memory', 'requests.cpu', 'requests.memory') | False | - | - ## ContainerEnvPodFieldSpec ### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -420,9 +420,9 @@ resource | Enum('limits.cpu', 'limits.memory', 'requests.cpu', 'requests.memory' Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -apiVersion | Nullable<Enum('v1')> | False | - | - -fieldPath | Enum('metadata.name', 'metadata.namespace', 'metadata.labels', 'metadata.annotations', 'spec.nodeName', 'spec.serviceAccountName', 'status.podIP') | False | - | - -name | EnvString | False | - | - +apiVersion | Nullable<[Enum](#enum)('v1')> | False | - | - +fieldPath | [Enum](#enum)('metadata.name', 'metadata.namespace', 'metadata.labels', 'metadata.annotations', 'spec.nodeName', 'spec.serviceAccountName', 'status.pod[IP](#ip)') | False | - | - +name | Env[String](#string) | False | - | - ## ContainerEnvSecretSpec ### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -434,9 +434,9 @@ name | EnvString | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -key | NonEmpty<String> | False | - | - -name | EnvString | False | - | - -secret_name | Identifier | False | - | - +key | NonEmpty<[String](#string)> | False | - | - +name | Env[String](#string) | False | - | - +secret_name | [Identifier](#identifier) | False | - | - ## ContainerEnvSpec ### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -448,8 +448,8 @@ secret_name | Identifier | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | EnvString | False | - | - -value | String | False | - | - +name | Env[String](#string) | False | - | - +value | [String](#string) | False | - | - ## ContainerPort ### Parent types: - [ContainerSpec](#containerspec) @@ -457,11 +457,11 @@ value | String | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -containerPort | Positive<NonZero<Integer>> | False | - | - -hostIP | Nullable<IP> | False | - | - -hostPort | Nullable<Positive<NonZero<Integer>>> | False | - | - -name | Nullable<String> | False | - | - -protocol | Enum('TCP', 'UDP') | False | - | - +containerPort | Positive<NonZero<[Integer](#integer)>> | False | - | - +hostIP | Nullable<[IP](#ip)> | False | - | - +hostPort | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +name | Nullable<[String](#string)> | False | - | - +protocol | [Enum](#enum)('TCP', 'UDP') | False | - | - ## ContainerProbeBaseSpec ### Children: - [ContainerProbeTCPPortSpec](#containerprobetcpportspec) @@ -472,11 +472,11 @@ protocol | Enum('TCP', 'UDP') | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - -periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +failureThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +initialDelaySeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - +periodSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +successThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - ## ContainerProbeHTTPSpec ### Parents: - [ContainerProbeBaseSpec](#containerprobebasespec) @@ -486,15 +486,15 @@ timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -host | Nullable<Domain> | False | - | - -initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - -path | NonEmpty<Path> | False | - | - -periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -port | Positive<NonZero<Integer>> | False | <unknown transformation> | - -scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - -successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +failureThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +host | Nullable<[Domain](#domain)> | False | - | - +initialDelaySeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - +path | NonEmpty<[Path](#path)> | False | - | - +periodSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +port | Positive<NonZero<[Integer](#integer)>> | False | <unknown transformation> | - +scheme | Nullable<[Enum](#enum)('HTTP', 'HTTPS')> | False | - | - +successThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - ## ContainerProbeTCPPortSpec ### Parents: - [ContainerProbeBaseSpec](#containerprobebasespec) @@ -504,12 +504,12 @@ timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -failureThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -initialDelaySeconds | Nullable<Positive<Integer>> | False | - | - -periodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -port | Positive<NonZero<Integer>> | False | <unknown transformation> | - -successThreshold | Nullable<Positive<NonZero<Integer>>> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +failureThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +initialDelaySeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - +periodSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +port | Positive<NonZero<[Integer](#integer)>> | False | <unknown transformation> | - +successThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - ## ContainerResourceEachSpec ### Parent types: - [ContainerResourceSpec](#containerresourcespec) @@ -517,7 +517,7 @@ timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -cpu | Nullable<Positive<NonZero<Number>>> | False | <unknown transformation> | - +cpu | Nullable<Positive<NonZero<[Number](#number)>>> | False | <unknown transformation> | - memory | Nullable<Memory> | False | - | - ## ContainerResourceSpec ### Parent types: @@ -541,20 +541,20 @@ requests | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -args | Nullable<List<String>> | False | - | - -command | Nullable<List<String>> | False | - | - +name | [Identifier](#identifier) | True | - | - +args | Nullable<List<[String](#string)>> | False | - | - +command | Nullable<List<[String](#string)>> | False | - | - env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - -image | NonEmpty<String> | False | - | - -imagePullPolicy | Nullable<Enum('Always', 'IfNotPresent')> | False | - | - -kind | Nullable<Enum('DockerImage')> | False | - | - +image | NonEmpty<[String](#string)> | False | - | - +imagePullPolicy | Nullable<[Enum](#enum)('Always', 'IfNotPresent')> | False | - | - +kind | Nullable<[Enum](#enum)('DockerImage')> | False | - | - lifecycle | Nullable<[LifeCycle](#lifecycle)> | False | - | - livenessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - ports | Nullable<List<[ContainerPort](#containerport)>> | False | <unknown transformation> | - readinessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - securityContext | Nullable<[SecurityContext](#securitycontext)> | False | - | - -terminationMessagePath | Nullable<NonEmpty<Path>> | False | - | - +terminationMessagePath | Nullable<NonEmpty<[Path](#path)>> | False | - | - volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | <unknown transformation> | - ## ContainerVolumeMountSpec ### Parent types: @@ -564,9 +564,9 @@ volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemo Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - -path | NonEmpty<Path> | False | - | - -readOnly | Nullable<Boolean> | False | - | - +name | [Identifier](#identifier) | False | - | - +path | NonEmpty<[Path](#path)> | False | - | - +readOnly | Nullable<[Boolean](#boolean)> | False | - | - ## DCBaseUpdateStrategy ### Children: - [DCRecreateStrategy](#dcrecreatestrategy) @@ -578,9 +578,9 @@ readOnly | Nullable<Boolean> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -annotations | Map<String, String> | False | - | - -labels | Map<String, String> | False | - | - +activeDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +annotations | Map<[String](#string), [String](#string)> | False | - | - +labels | Map<[String](#string), [String](#string)> | False | - | - resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## DCConfigChangeTrigger ### Parents: @@ -598,9 +598,9 @@ resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | Fa Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -command | Nullable<List<String>> | False | - | - +command | Nullable<List<[String](#string)>> | False | - | - environment | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - -image | NonEmpty<String> | False | - | - +image | NonEmpty<[String](#string)> | False | - | - ## DCCustomStrategy ### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) @@ -610,10 +610,10 @@ image | NonEmpty<String> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -annotations | Map<String, String> | False | - | - +activeDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +annotations | Map<[String](#string), [String](#string)> | False | - | - customParams | [DCCustomParams](#dccustomparams) | False | - | - -labels | Map<String, String> | False | - | - +labels | Map<[String](#string), [String](#string)> | False | - | - resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## DCImageChangeTrigger ### Parents: @@ -629,7 +629,7 @@ resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | Fa Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- execNewPod | Nullable<[DCLifecycleNewPod](#dclifecyclenewpod)> | False | - | - -failurePolicy | Enum('Abort', 'Retry', 'Ignore') | False | - | - +failurePolicy | [Enum](#enum)('Abort', 'Retry', 'Ignore') | False | - | - tagImages | Nullable<[DCTagImages](#dctagimages)> | False | - | - ## DCLifecycleNewPod ### Parents: @@ -640,11 +640,11 @@ tagImages | Nullable<[DCTagImages](#dctagimages)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -command | NonEmpty<List<String>> | False | - | - -containerName | Identifier | False | - | - +command | NonEmpty<List<[String](#string)>> | False | - | - +containerName | [Identifier](#identifier) | False | - | - env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | - | - -volumes | Nullable<List<Identifier>> | False | - | - +volumes | Nullable<List<[Identifier](#identifier)>> | False | - | - ## DCRecreateParams ### Parent types: - [DCRecreateStrategy](#dcrecreatestrategy) @@ -655,7 +655,7 @@ Name | Type | Identifier | Type Transformation | Aliases mid | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - ## DCRecreateStrategy ### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) @@ -665,10 +665,10 @@ timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -annotations | Map<String, String> | False | - | - +activeDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +annotations | Map<[String](#string), [String](#string)> | False | - | - customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - -labels | Map<String, String> | False | - | - +labels | Map<[String](#string), [String](#string)> | False | - | - recreateParams | Nullable<[DCRecreateParams](#dcrecreateparams)> | False | - | - resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## DCRollingParams @@ -678,13 +678,13 @@ resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | Fa Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -intervalSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -maxSurge | SurgeSpec | False | - | - -maxUnavailable | SurgeSpec | False | - | - +intervalSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +maxSurge | [SurgeSpec](#surgespec) | False | - | - +maxUnavailable | [SurgeSpec](#surgespec) | False | - | - post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -updatePeriodSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +updatePeriodSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - ## DCRollingStrategy ### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) @@ -694,10 +694,10 @@ updatePeriodSeconds | Nullable<Positive<NonZero<Integer>>> | F Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -annotations | Map<String, String> | False | - | - +activeDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +annotations | Map<[String](#string), [String](#string)> | False | - | - customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - -labels | Map<String, String> | False | - | - +labels | Map<[String](#string), [String](#string)> | False | - | - resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - rollingParams | Nullable<[DCRollingParams](#dcrollingparams)> | False | - | - ## DCTagImages @@ -707,14 +707,14 @@ rollingParams | Nullable<[DCRollingParams](#dcrollingparams)> | False | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -containerName | Identifier | False | - | - -toApiVersion | Nullable<String> | False | - | - -toFieldPath | Nullable<String> | False | - | - -toKind | Nullable<Enum('Deployment', 'DeploymentConfig', 'ImageStreamTag')> | False | - | - -toName | Nullable<Identifier> | False | - | - -toNamespace | Nullable<Identifier> | False | - | - -toResourceVersion | Nullable<String> | False | - | - -toUid | Nullable<String> | False | - | - +containerName | [Identifier](#identifier) | False | - | - +toApiVersion | Nullable<[String](#string)> | False | - | - +toFieldPath | Nullable<[String](#string)> | False | - | - +toKind | Nullable<[Enum](#enum)('Deployment', 'DeploymentConfig', 'ImageStreamTag')> | False | - | - +toName | Nullable<[Identifier](#identifier)> | False | - | - +toNamespace | Nullable<[Identifier](#identifier)> | False | - | - +toResourceVersion | Nullable<[String](#string)> | False | - | - +toUid | Nullable<[String](#string)> | False | - | - ## DCTrigger ### Children: - [DCConfigChangeTrigger](#dcconfigchangetrigger) @@ -733,7 +733,7 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - +name | [Identifier](#identifier) | True | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | <unknown transformation> | - ## [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) @@ -753,13 +753,13 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -paused | Nullable<Boolean> | False | - | - +name | [Identifier](#identifier) | True | - | - +minReadySeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +paused | Nullable<[Boolean](#boolean)> | False | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -progressDeadlineSeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -replicas | Positive<NonZero<Integer>> | False | - | - -revisionHistoryLimit | Nullable<Positive<NonZero<Integer>>> | False | - | - +progressDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +replicas | Positive<NonZero<[Integer](#integer)>> | False | - | - +revisionHistoryLimit | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | - | - strategy | Nullable<[DplBaseUpdateStrategy](#dplbaseupdatestrategy)> | False | - | - ## DeploymentConfig @@ -772,15 +772,15 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - -paused | Nullable<Boolean> | False | - | - +name | [Identifier](#identifier) | True | - | - +minReadySeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +paused | Nullable<[Boolean](#boolean)> | False | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -replicas | Positive<NonZero<Integer>> | False | - | - -revisionHistoryLimit | Nullable<Positive<NonZero<Integer>>> | False | - | - -selector | Nullable<Map<String, String>> | False | - | - +replicas | Positive<NonZero<[Integer](#integer)>> | False | - | - +revisionHistoryLimit | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +selector | Nullable<Map<[String](#string), [String](#string)>> | False | - | - strategy | [DCBaseUpdateStrategy](#dcbaseupdatestrategy) | False | - | - -test | Boolean | False | - | - +test | [Boolean](#boolean) | False | - | - triggers | List<[DCTrigger](#dctrigger)> | False | - | - ## DockerCredentials ### Parents: @@ -794,10 +794,10 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -dockers | Map<String, Map<String, String>> | False | - | - -secrets | Map<String, String> | False | - | - -type | NonEmpty<String> | False | - | - +name | [Identifier](#identifier) | True | - | - +dockers | Map<[String](#string), Map<[String](#string), [String](#string)>> | False | - | - +secrets | Map<[String](#string), [String](#string)> | False | - | - +type | NonEmpty<[String](#string)> | False | - | - ## DplBaseUpdateStrategy ### Children: - [DplRecreateStrategy](#dplrecreatestrategy) @@ -818,8 +818,8 @@ type | NonEmpty<String> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -maxSurge | SurgeSpec | False | - | - -maxUnavailable | SurgeSpec | False | - | - +maxSurge | [SurgeSpec](#surgespec) | False | - | - +maxUnavailable | [SurgeSpec](#surgespec) | False | - | - ## Group ### Metadata Name | Format @@ -830,8 +830,8 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -users | NonEmpty<List<UserIdentifier>> | False | - | - +name | [Identifier](#identifier) | True | - | - +users | NonEmpty<List<User[Identifier](#identifier)>> | False | - | - ## Job ### Metadata Name | Format @@ -842,11 +842,11 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -activeDeadlineSeconds | Nullable<Positive<Integer>> | False | - | - -completions | Nullable<Positive<NonZero<Integer>>> | False | - | - -manualSelector | Nullable<Boolean> | False | - | - -parallelism | Nullable<Positive<NonZero<Integer>>> | False | - | - +name | [Identifier](#identifier) | True | - | - +activeDeadlineSeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - +completions | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +manualSelector | Nullable<[Boolean](#boolean)> | False | - | - +parallelism | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | - | - ## LifeCycle @@ -867,7 +867,7 @@ preStop | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -command | NonEmpty<List<String>> | False | - | - +command | NonEmpty<List<[String](#string)>> | False | - | - ## LifeCycleHTTP ### Parents: - [LifeCycleProbe](#lifecycleprobe) @@ -877,9 +877,9 @@ command | NonEmpty<List<String>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -path | NonEmpty<Path> | False | - | - -port | Positive<NonZero<Integer>> | False | - | - -scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - +path | NonEmpty<[Path](#path)> | False | - | - +port | Positive<NonZero<[Integer](#integer)>> | False | - | - +scheme | Nullable<[Enum](#enum)('HTTP', 'HTTPS')> | False | - | - ## LifeCycleProbe ### Children: - [LifeCycleExec](#lifecycleexec) @@ -893,9 +893,9 @@ scheme | Nullable<Enum('HTTP', 'HTTPS')> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -key | NonEmpty<String> | False | - | - -operator | Enum('In', 'NotIn', 'Exists', 'DoesNotExist') | False | - | - -values | Nullable<List<String>> | False | - | - +key | NonEmpty<[String](#string)> | False | - | - +operator | [Enum](#enum)('In', 'NotIn', 'Exists', 'DoesNotExist') | False | - | - +values | Nullable<List<[String](#string)>> | False | - | - ## MatchExpressionsSelector ### Parents: - [BaseSelector](#baseselector) @@ -921,7 +921,7 @@ matchExpressions | NonEmpty<List<[MatchExpression](#matchexpression)>&g Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -matchLabels | Map<String, String> | False | - | - +matchLabels | Map<[String](#string), [String](#string)> | False | - | - ## Namespace ### Children: - [Project](#project) @@ -934,7 +934,7 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - +name | [Identifier](#identifier) | True | - | - ## PersistentVolume ### Metadata Name | Format @@ -945,12 +945,12 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - +name | [Identifier](#identifier) | True | - | - +accessModes | List<[Enum](#enum)('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - awsElasticBlockStore | Nullable<[AWSElasticBlockStore](#awselasticblockstore)> | False | - | - capacity | Memory | False | - | - claimRef | Nullable<[PersistentVolumeRef](#persistentvolumeref)> | False | - | - -persistentVolumeReclaimPolicy | Nullable<Enum('Retain', 'Recycle', 'Delete')> | False | - | - +persistentVolumeReclaimPolicy | Nullable<[Enum](#enum)('Retain', 'Recycle', 'Delete')> | False | - | - ## PersistentVolumeClaim ### Metadata Name | Format @@ -961,11 +961,11 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -accessModes | List<Enum('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - +name | [Identifier](#identifier) | True | - | - +accessModes | List<[Enum](#enum)('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - request | Memory | False | - | - selector | Nullable<[BaseSelector](#baseselector)> | False | - | - -volumeName | Nullable<Identifier> | False | <unknown transformation> | - +volumeName | Nullable<[Identifier](#identifier)> | False | <unknown transformation> | - ## PersistentVolumeRef ### Parent types: - [PersistentVolume](#persistentvolume) @@ -973,10 +973,10 @@ volumeName | Nullable<Identifier> | False | <unknown transformation> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -apiVersion | Nullable<String> | False | - | - -kind | Nullable<CaseIdentifier> | False | - | - -name | Nullable<Identifier> | False | - | - -ns | Nullable<Identifier> | False | - | - +apiVersion | Nullable<[String](#string)> | False | - | - +kind | Nullable<[Case[Identifier](#identifier)](#caseidentifier)> | False | - | - +name | Nullable<[Identifier](#identifier)> | False | - | - +ns | Nullable<[Identifier](#identifier)> | False | - | - ## PodImagePullSecret ### Parent types: - [PodTemplateSpec](#podtemplatespec) @@ -984,7 +984,7 @@ ns | Nullable<Identifier> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - +name | [Identifier](#identifier) | False | - | - ## PodTemplateSpec ### Parent types: - [DaemonSet](#daemonset) @@ -1002,17 +1002,17 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- containers | NonEmpty<List<[ContainerSpec](#containerspec)>> | False | - | - -dnsPolicy | Nullable<Enum('ClusterFirst')> | False | - | - -hostIPC | Nullable<Boolean> | False | - | - -hostNetwork | Nullable<Boolean> | False | - | - -hostPID | Nullable<Boolean> | False | - | - +dnsPolicy | Nullable<[Enum](#enum)('ClusterFirst')> | False | - | - +hostIPC | Nullable<[Boolean](#boolean)> | False | - | - +hostNetwork | Nullable<[Boolean](#boolean)> | False | - | - +hostPID | Nullable<[Boolean](#boolean)> | False | - | - imagePullSecrets | Nullable<List<[PodImagePullSecret](#podimagepullsecret)>> | False | <unknown transformation> | - -name | Nullable<Identifier> | False | - | - -nodeSelector | Nullable<Map<String, String>> | False | - | - -restartPolicy | Nullable<Enum('Always', 'OnFailure', 'Never')> | False | - | - +name | Nullable<[Identifier](#identifier)> | False | - | - +nodeSelector | Nullable<Map<[String](#string), [String](#string)>> | False | - | - +restartPolicy | Nullable<[Enum](#enum)('Always', 'OnFailure', 'Never')> | False | - | - securityContext | Nullable<[SecurityContext](#securitycontext)> | False | - | - -serviceAccountName | Nullable<Identifier> | False | <unknown transformation> | [serviceAccount](#serviceaccount) -terminationGracePeriodSeconds | Nullable<Positive<Integer>> | False | - | - +serviceAccountName | Nullable<[Identifier](#identifier)> | False | <unknown transformation> | [serviceAccount](#serviceaccount) +terminationGracePeriodSeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - volumes | Nullable<List<[PodVolumeBaseSpec](#podvolumebasespec)>> | False | - | - ## PodVolumeBaseSpec ### Children: @@ -1028,7 +1028,7 @@ volumes | Nullable<List<[PodVolumeBaseSpec](#podvolumebasespec)>> | Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - +name | [Identifier](#identifier) | False | - | - ## PodVolumeConfigMapSpec ### Parents: - [PodVolumeItemMapper](#podvolumeitemmapper) @@ -1039,10 +1039,10 @@ name | Identifier | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -defaultMode | Nullable<Positive<Integer>> | False | - | - -item_map | Nullable<Map<String, String>> | False | - | - -map_name | Identifier | False | - | - -name | Identifier | False | - | - +defaultMode | Nullable<Positive<[Integer](#integer)>> | False | - | - +item_map | Nullable<Map<[String](#string), [String](#string)>> | False | - | - +map_name | [Identifier](#identifier) | False | - | - +name | [Identifier](#identifier) | False | - | - ## PodVolumeEmptyDirSpec ### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) @@ -1052,7 +1052,7 @@ name | Identifier | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - +name | [Identifier](#identifier) | False | - | - ## PodVolumeHostSpec ### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) @@ -1062,8 +1062,8 @@ name | Identifier | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - -path | String | False | - | - +name | [Identifier](#identifier) | False | - | - +path | [String](#string) | False | - | - ## PodVolumeItemMapper ### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) @@ -1076,8 +1076,8 @@ path | String | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -item_map | Nullable<Map<String, String>> | False | - | - -name | Identifier | False | - | - +item_map | Nullable<Map<[String](#string), [String](#string)>> | False | - | - +name | [Identifier](#identifier) | False | - | - ## PodVolumePVCSpec ### Parents: - [PodVolumeBaseSpec](#podvolumebasespec) @@ -1087,8 +1087,8 @@ name | Identifier | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -claimName | Identifier | False | - | - -name | Identifier | False | - | - +claimName | [Identifier](#identifier) | False | - | - +name | [Identifier](#identifier) | False | - | - ## PodVolumeSecretSpec ### Parents: - [PodVolumeItemMapper](#podvolumeitemmapper) @@ -1099,10 +1099,10 @@ name | Identifier | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -defaultMode | Nullable<Positive<Integer>> | False | - | - -item_map | Nullable<Map<String, String>> | False | - | - -name | Identifier | False | - | - -secret_name | Identifier | False | - | - +defaultMode | Nullable<Positive<[Integer](#integer)>> | False | - | - +item_map | Nullable<Map<[String](#string), [String](#string)>> | False | - | - +name | [Identifier](#identifier) | False | - | - +secret_name | [Identifier](#identifier) | False | - | - ## PolicyBinding ### Metadata Name | Format @@ -1113,7 +1113,7 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | ColonIdentifier | True | - | - +name | [ColonIdentifier](#colonidentifier) | True | - | - roleBindings | List<[PolicyBindingRoleBinding](#policybindingrolebinding)> | False | <unknown transformation> | - ## PolicyBindingRoleBinding ### Parents: @@ -1124,9 +1124,9 @@ roleBindings | List<[PolicyBindingRoleBinding](#policybindingrolebinding)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -metadata | Nullable<Map<String, String>> | False | - | - -name | SystemIdentifier | False | - | - -ns | Identifier | False | - | - +metadata | Nullable<Map<[String](#string), [String](#string)>> | False | - | - +name | System[Identifier](#identifier) | False | - | - +ns | [Identifier](#identifier) | False | - | - roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## PolicyRule @@ -1138,12 +1138,12 @@ subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | < Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -apiGroups | NonEmpty<List<String>> | False | - | - -attributeRestrictions | Nullable<String> | False | - | - -nonResourceURLs | Nullable<List<String>> | False | - | - -resourceNames | Nullable<List<String>> | False | - | - -resources | NonEmpty<List<NonEmpty<String>>> | False | - | - -verbs | NonEmpty<List<Enum('get', 'list', 'create', 'update', 'delete', 'deletecollection', 'watch')>> | False | - | - +apiGroups | NonEmpty<List<[String](#string)>> | False | - | - +attributeRestrictions | Nullable<[String](#string)> | False | - | - +nonResourceURLs | Nullable<List<[String](#string)>> | False | - | - +resourceNames | Nullable<List<[String](#string)>> | False | - | - +resources | NonEmpty<List<NonEmpty<[String](#string)>>> | False | - | - +verbs | NonEmpty<List<[Enum](#enum)('get', 'list', 'create', 'update', 'delete', 'deletecollection', 'watch')>> | False | - | - ## Project ### Parents: - [Namespace](#namespace) @@ -1156,7 +1156,7 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - +name | [Identifier](#identifier) | True | - | - ## ReplicationController ### Metadata Name | Format @@ -1167,11 +1167,11 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -minReadySeconds | Nullable<Positive<NonZero<Integer>>> | False | - | - +name | [Identifier](#identifier) | True | - | - +minReadySeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -replicas | Positive<NonZero<Integer>> | False | - | - -selector | Nullable<Map<String, String>> | False | - | - +replicas | Positive<NonZero<[Integer](#integer)>> | False | - | - +selector | Nullable<Map<[String](#string), [String](#string)>> | False | - | - ## Role ### Parents: - [RoleBase](#rolebase) @@ -1184,7 +1184,7 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - +name | [Identifier](#identifier) | True | - | - rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ## RoleBinding ### Parents: @@ -1199,7 +1199,7 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | SystemIdentifier | True | - | - +name | [SystemIdentifier](#systemidentifier) | True | - | - roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## RoleRef @@ -1212,8 +1212,8 @@ subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | < Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Nullable<SystemIdentifier> | False | - | - -ns | Nullable<Identifier> | False | - | - +name | Nullable<System[Identifier](#identifier)> | False | - | - +ns | Nullable<[Identifier](#identifier)> | False | - | - ## RoleSubject ### Parent types: - [ClusterRoleBinding](#clusterrolebinding) @@ -1224,9 +1224,9 @@ ns | Nullable<Identifier> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -kind | CaseIdentifier | False | - | - -name | String | False | - | - -ns | Nullable<Identifier> | False | - | - +kind | [Case[Identifier](#identifier)](#caseidentifier) | False | - | - +name | [String](#string) | False | - | - +ns | Nullable<[Identifier](#identifier)> | False | - | - ## Route ### Metadata Name | Format @@ -1237,12 +1237,12 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -host | Domain | False | - | - +name | [Identifier](#identifier) | True | - | - +host | [Domain](#domain) | False | - | - port | [RouteDestPort](#routedestport) | False | - | - tls | Nullable<[RouteTLS](#routetls)> | False | - | - to | NonEmpty<List<[RouteDest](#routedest)>> | False | - | - -wildcardPolicy | Enum('Subdomain', 'None') | False | - | - +wildcardPolicy | [Enum](#enum)('Subdomain', 'None') | False | - | - ## RouteDest ### Children: - [RouteDestService](#routedestservice) @@ -1252,7 +1252,7 @@ wildcardPolicy | Enum('Subdomain', 'None') | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -weight | Positive<NonZero<Integer>> | False | - | - +weight | Positive<NonZero<[Integer](#integer)>> | False | - | - ## RouteDestPort ### Parent types: - [Route](#route) @@ -1260,7 +1260,7 @@ weight | Positive<NonZero<Integer>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -targetPort | Identifier | False | - | - +targetPort | [Identifier](#identifier) | False | - | - ## RouteDestService ### Parents: - [RouteDest](#routedest) @@ -1270,8 +1270,8 @@ targetPort | Identifier | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - -weight | Positive<NonZero<Integer>> | False | - | - +name | [Identifier](#identifier) | False | - | - +weight | Positive<NonZero<[Integer](#integer)>> | False | - | - ## RouteTLS ### Parent types: - [Route](#route) @@ -1279,12 +1279,12 @@ weight | Positive<NonZero<Integer>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -caCertificate | Nullable<NonEmpty<String>> | False | - | - -certificate | Nullable<NonEmpty<String>> | False | - | - -destinationCACertificate | Nullable<NonEmpty<String>> | False | - | - -insecureEdgeTerminationPolicy | Enum('Allow', 'Disable', 'Redirect') | False | - | - -key | Nullable<NonEmpty<String>> | False | - | - -termination | Enum('edge', 'reencrypt', 'passthrough') | False | - | - +caCertificate | Nullable<NonEmpty<[String](#string)>> | False | - | - +certificate | Nullable<NonEmpty<[String](#string)>> | False | - | - +destinationCACertificate | Nullable<NonEmpty<[String](#string)>> | False | - | - +insecureEdgeTerminationPolicy | [Enum](#enum)('Allow', 'Disable', 'Redirect') | False | - | - +key | Nullable<NonEmpty<[String](#string)>> | False | - | - +termination | [Enum](#enum)('edge', 'reencrypt', 'passthrough') | False | - | - ## SAImgPullSecretSubject ### Parent types: - [ServiceAccount](#serviceaccount) @@ -1292,7 +1292,7 @@ termination | Enum('edge', 'reencrypt', 'passthrough') | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | False | - | - +name | [Identifier](#identifier) | False | - | - ## SASecretSubject ### Parent types: - [ServiceAccount](#serviceaccount) @@ -1300,9 +1300,9 @@ name | Identifier | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -kind | Nullable<CaseIdentifier> | False | - | - -name | Nullable<Identifier> | False | - | - -ns | Nullable<Identifier> | False | - | - +kind | Nullable<[Case[Identifier](#identifier)](#caseidentifier)> | False | - | - +name | Nullable<[Identifier](#identifier)> | False | - | - +ns | Nullable<[Identifier](#identifier)> | False | - | - ## SCCGroupRange ### Parent types: - [SCCGroups](#sccgroups) @@ -1310,8 +1310,8 @@ ns | Nullable<Identifier> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -max | Positive<NonZero<Integer>> | False | - | - -min | Positive<NonZero<Integer>> | False | - | - +max | Positive<NonZero<[Integer](#integer)>> | False | - | - +min | Positive<NonZero<[Integer](#integer)>> | False | - | - ## SCCGroups ### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) @@ -1320,7 +1320,7 @@ min | Positive<NonZero<Integer>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- ranges | Nullable<List<[SCCGroupRange](#sccgrouprange)>> | False | - | - -type | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - +type | Nullable<[Enum](#enum)('MustRunAs', 'RunAsAny')> | False | - | - ## SCCRunAsUser ### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) @@ -1328,10 +1328,10 @@ type | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -type | Enum('MustRunAs', 'RunAsAny', 'MustRunAsRange', 'MustRunAsNonRoot') | False | - | - -uid | Nullable<Positive<NonZero<Integer>>> | False | - | - -uidRangeMax | Nullable<Positive<NonZero<Integer>>> | False | - | - -uidRangeMin | Nullable<Positive<NonZero<Integer>>> | False | - | - +type | [Enum](#enum)('MustRunAs', 'RunAsAny', 'MustRunAsRange', 'MustRunAsNonRoot') | False | - | - +uid | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +uidRangeMax | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +uidRangeMin | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - ## SCCSELinux ### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) @@ -1339,11 +1339,11 @@ uidRangeMin | Nullable<Positive<NonZero<Integer>>> | False | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -level | Nullable<String> | False | - | - -role | Nullable<String> | False | - | - -strategy | Nullable<Enum('MustRunAs', 'RunAsAny')> | False | - | - -type | Nullable<String> | False | - | - -user | Nullable<String> | False | - | - +level | Nullable<[String](#string)> | False | - | - +role | Nullable<[String](#string)> | False | - | - +strategy | Nullable<[Enum](#enum)('MustRunAs', 'RunAsAny')> | False | - | - +type | Nullable<[String](#string)> | False | - | - +user | Nullable<[String](#string)> | False | - | - ## Secret ### Children: - [DockerCredentials](#dockercredentials) @@ -1357,9 +1357,9 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -secrets | Map<String, String> | False | - | - -type | NonEmpty<String> | False | - | - +name | [Identifier](#identifier) | True | - | - +secrets | Map<[String](#string), [String](#string)> | False | - | - +type | NonEmpty<[String](#string)> | False | - | - ## SecurityContext ### Parent types: - [ContainerSpec](#containerspec) @@ -1368,11 +1368,11 @@ type | NonEmpty<String> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -fsGroup | Nullable<Integer> | False | - | - -privileged | Nullable<Boolean> | False | - | - -runAsNonRoot | Nullable<Boolean> | False | - | - -runAsUser | Nullable<Integer> | False | - | - -supplementalGroups | Nullable<List<Integer>> | False | - | - +fsGroup | Nullable<[Integer](#integer)> | False | - | - +privileged | Nullable<[Boolean](#boolean)> | False | - | - +runAsNonRoot | Nullable<[Boolean](#boolean)> | False | - | - +runAsUser | Nullable<[Integer](#integer)> | False | - | - +supplementalGroups | Nullable<List<[Integer](#integer)>> | False | - | - ## SecurityContextConstraints ### Metadata Name | Format @@ -1383,26 +1383,26 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -allowHostDirVolumePlugin | Boolean | False | - | - -allowHostIPC | Boolean | False | - | - -allowHostNetwork | Boolean | False | - | - -allowHostPID | Boolean | False | - | - -allowHostPorts | Boolean | False | - | - -allowPrivilegedContainer | Boolean | False | - | - -allowedCapabilities | Nullable<List<String>> | False | - | - -defaultAddCapabilities | Nullable<List<String>> | False | - | - +name | [Identifier](#identifier) | True | - | - +allowHostDirVolumePlugin | [Boolean](#boolean) | False | - | - +allowHostIPC | [Boolean](#boolean) | False | - | - +allowHostNetwork | [Boolean](#boolean) | False | - | - +allowHostPID | [Boolean](#boolean) | False | - | - +allowHostPorts | [Boolean](#boolean) | False | - | - +allowPrivilegedContainer | [Boolean](#boolean) | False | - | - +allowedCapabilities | Nullable<List<[String](#string)>> | False | - | - +defaultAddCapabilities | Nullable<List<[String](#string)>> | False | - | - fsGroup | Nullable<[SCCGroups](#sccgroups)> | False | - | - -groups | List<SystemIdentifier> | False | - | - -priority | Nullable<Positive<Integer>> | False | - | - -readOnlyRootFilesystem | Boolean | False | - | - -requiredDropCapabilities | Nullable<List<String>> | False | - | - +groups | List<System[Identifier](#identifier)> | False | - | - +priority | Nullable<Positive<[Integer](#integer)>> | False | - | - +readOnlyRootFilesystem | [Boolean](#boolean) | False | - | - +requiredDropCapabilities | Nullable<List<[String](#string)>> | False | - | - runAsUser | Nullable<[SCCRunAsUser](#sccrunasuser)> | False | - | - seLinuxContext | Nullable<[SCCSELinux](#sccselinux)> | False | - | - -seccompProfiles | Nullable<List<String>> | False | - | - +seccompProfiles | Nullable<List<[String](#string)>> | False | - | - supplementalGroups | Nullable<[SCCGroups](#sccgroups)> | False | - | - -users | List<SystemIdentifier> | False | - | - -volumes | List<Enum('configMap', 'downwardAPI', 'emptyDir', 'hostPath', 'nfs', 'persistentVolumeClaim', 'secret', '*')> | False | - | - +users | List<System[Identifier](#identifier)> | False | - | - +volumes | List<[Enum](#enum)('configMap', 'downwardAPI', 'emptyDir', 'host[Path](#path)', 'nfs', 'persistentVolumeClaim', 'secret', '*')> | False | - | - ## Service ### Children: - [ClusterIPService](#clusteripservice) @@ -1416,10 +1416,10 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - +name | [Identifier](#identifier) | True | - | - ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - -selector | NonEmpty<Map<String, String>> | False | <unknown transformation> | - -sessionAffinity | Nullable<Enum('ClientIP', 'None')> | False | - | - +selector | NonEmpty<Map<[String](#string), [String](#string)>> | False | <unknown transformation> | - +sessionAffinity | Nullable<[Enum](#enum)('Client[IP](#ip)', 'None')> | False | - | - ## ServiceAccount ### Metadata Name | Format @@ -1430,7 +1430,7 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - +name | [Identifier](#identifier) | True | - | - imagePullSecrets | Nullable<List<[SAImgPullSecretSubject](#saimgpullsecretsubject)>> | False | <unknown transformation> | - secrets | Nullable<List<[SASecretSubject](#sasecretsubject)>> | False | <unknown transformation> | - ## ServicePort @@ -1442,10 +1442,10 @@ secrets | Nullable<List<[SASecretSubject](#sasecretsubject)>> | Fals Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Nullable<Identifier> | False | - | - -port | Positive<NonZero<Integer>> | False | - | - -protocol | Enum('TCP', 'UDP') | False | - | - -targetPort | OneOf<Positive<NonZero<Integer>>, Identifier> | False | - | - +name | Nullable<[Identifier](#identifier)> | False | - | - +port | Positive<NonZero<[Integer](#integer)>> | False | - | - +protocol | [Enum](#enum)('TCP', 'UDP') | False | - | - +targetPort | OneOf<Positive<NonZero<[Integer](#integer)>>, [Identifier](#identifier)> | False | - | - ## StorageClass ### Metadata Name | Format @@ -1456,9 +1456,9 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -parameters | Map<String, String> | False | - | - -provisioner | String | False | - | - +name | [Identifier](#identifier) | True | - | - +parameters | Map<[String](#string), [String](#string)> | False | - | - +provisioner | [String](#string) | False | - | - ## TLSCredentials ### Parents: - [Secret](#secret) @@ -1471,11 +1471,11 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Identifier | True | - | - -secrets | Map<String, String> | False | - | - -tls_cert | String | False | - | - -tls_key | String | False | - | - -type | NonEmpty<String> | False | - | - +name | [Identifier](#identifier) | True | - | - +secrets | Map<[String](#string), [String](#string)> | False | - | - +tls_cert | [String](#string) | False | - | - +tls_key | [String](#string) | False | - | - +type | NonEmpty<[String](#string)> | False | - | - ## User ### Metadata Name | Format @@ -1486,6 +1486,6 @@ labels | Map<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | UserIdentifier | True | - | - -fullName | Nullable<String> | False | - | - -identities | NonEmpty<List<NonEmpty<String>>> | False | - | - +name | [UserIdentifier](#useridentifier) | True | - | - +fullName | Nullable<[String](#string)> | False | - | - +identities | NonEmpty<List<NonEmpty<[String](#string)>>> | False | - | - diff --git a/lib/kube_help.py b/lib/kube_help.py index 1b987c9..5479aec 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -169,7 +169,7 @@ def render_markdown(self, links=[]): txt += 'Name | Type | Identifier | Type Transformation | Aliases\n' txt += '---- | ---- | ---------- | ------------------- | -------\n' if self.class_identifier is not None: - txt += '{} | {} | True | - | - \n'.format(self.class_identifier, self.class_types[self.class_identifier].name()) + txt += '{} | {} | True | - | - \n'.format(self.class_identifier, self._get_markdown_link(self.class_types[self.class_identifier].name())) for p in sorted(self.class_types.keys()): if p == self.class_identifier: @@ -191,8 +191,8 @@ def render_markdown(self, links=[]): elif isinstance(original_type, dict): original_type = original_type['value'] classname = original_type.__name__ - display_type = self._decorate_obj_links(display=display_type, links=(links + [classname])) - # display_type = display_type.replace(classname, self._get_markdown_link(classname)) + display_type = display_type.replace(classname, self._get_markdown_link(classname)) + display_type = self._decorate_obj_links(display=display_type, links=links) txt += '{} | {} | False | {} | {} \n'.format(p, display_type, xf_data, is_mapped) diff --git a/lib/load_python.py b/lib/load_python.py index adffa64..a699865 100644 --- a/lib/load_python.py +++ b/lib/load_python.py @@ -250,7 +250,7 @@ def get_kube_types(cls): cls._kube_type = {} for k in kube_types.__dict__: - if isinstance(kube_types.__dict__[k], type) and k not in ('KubeType', 'Object'): + if isinstance(kube_types.__dict__[k], type) and k not in ('KubeType'): try: if isinstance(kube_objs.__dict__[k](), KubeType): cls._kube_type[k] = kube_types.__dict__[k] From 009b7099c1d1338a0c3ecec22d235eba4a3c4793 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 00:32:58 +0200 Subject: [PATCH 24/40] Different approch for markdown documentation --- docs/rubiks.class.md | 640 +++++++++++++++++++++---------------------- lib/kube_help.py | 8 +- lib/kube_types.py | 25 +- 3 files changed, 343 insertions(+), 330 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 698854a..7faaec2 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -276,26 +276,26 @@ Stay tuned to have more hint about this variable. Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- fsType | [Enum](#enum)('ext4') | False | - | - -volumeID | AWSVolID | False | - | - +volumeID | [AWSVolID](#awsvolid) | False | - | - ## AWSLoadBalancerService ### Parents: - [Service](#service) ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -aws-load-balancer-backend-protocol | Nullable<[Identifier](#identifier)> | False | - | - -aws-load-balancer-ssl-cert | Nullable<[ARN](#arn)> | False | - | - -externalTrafficPolicy | Nullable<[Enum](#enum)('Cluster', 'Local')> | False | - | - -ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - -selector | NonEmpty<Map<[String](#string), [String](#string)>> | False | <unknown transformation> | - -sessionAffinity | Nullable<[Enum](#enum)('Client[IP](#ip)', 'None')> | False | - | - +aws-load-balancer-backend-protocol | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - +aws-load-balancer-ssl-cert | [Nullable](#nullable)<[ARN](#arn)> | False | - | - +externalTrafficPolicy | [Nullable](#nullable)<[Enum](#enum)('Cluster', 'Local')> | False | - | - +ports | [NonEmpty](#nonempty)<[List](#list)<[[ServicePort](#serviceport)](#serviceport)>> | False | <unknown transformation> | - +selector | [NonEmpty](#nonempty)<[Map](#map)<[String](#string), [String](#string)>> | False | <unknown transformation> | - +sessionAffinity | [Nullable](#nullable)<[Enum](#enum)('ClientIP', 'None')> | False | - | - ## BaseSelector ### Children: - [MatchLabelsSelector](#matchlabelsselector) @@ -311,31 +311,31 @@ sessionAffinity | Nullable<[Enum](#enum)('Client[IP](#ip)', 'None')> | Fal ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -clusterIP | Nullable<[IP](#ip)v4> | False | - | - -ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - -selector | NonEmpty<Map<[String](#string), [String](#string)>> | False | <unknown transformation> | - -sessionAffinity | Nullable<[Enum](#enum)('Client[IP](#ip)', 'None')> | False | - | - +clusterIP | [Nullable](#nullable)<[IPv4](#ipv4)> | False | - | - +ports | [NonEmpty](#nonempty)<[List](#list)<[[ServicePort](#serviceport)](#serviceport)>> | False | <unknown transformation> | - +selector | [NonEmpty](#nonempty)<[Map](#map)<[String](#string), [String](#string)>> | False | <unknown transformation> | - +sessionAffinity | [Nullable](#nullable)<[Enum](#enum)('ClientIP', 'None')> | False | - | - ## ClusterRole ### Parents: - [RoleBase](#rolebase) ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - +rules | [NonEmpty](#nonempty)<[List](#list)<[[PolicyRule](#policyrule)](#policyrule)>> | False | - | - ## ClusterRoleBinding ### Parents: - [RoleBindingBase](#rolebindingbase) @@ -343,27 +343,27 @@ rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - -subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - +roleRef | [[RoleRef](#roleref)](#roleref) | False | <unknown transformation> | - +subjects | [NonEmpty](#nonempty)<[List](#list)<[[RoleSubject](#rolesubject)](#rolesubject)>> | False | <unknown transformation> | - ## ConfigMap ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -files | Map<[String](#string), [String](#string)> | False | - | - +files | [Map](#map)<[String](#string), [String](#string)> | False | - | - ## ContainerEnvBaseSpec ### Children: - [ContainerEnvSpec](#containerenvspec) @@ -379,7 +379,7 @@ files | Map<[String](#string), [String](#string)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Env[String](#string) | False | - | - +name | [EnvString](#envstring) | False | - | - ## ContainerEnvConfigMapSpec ### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -391,9 +391,9 @@ name | Env[String](#string) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -key | NonEmpty<[String](#string)> | False | - | - +key | [NonEmpty](#nonempty)<[String](#string)> | False | - | - map_name | [Identifier](#identifier) | False | - | - -name | Env[String](#string) | False | - | - +name | [EnvString](#envstring) | False | - | - ## ContainerEnvContainerResourceSpec ### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -405,9 +405,9 @@ name | Env[String](#string) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -containerName | Nullable<[Identifier](#identifier)> | False | - | - -divisor | Nullable<NonEmpty<[String](#string)>> | False | - | - -name | Env[String](#string) | False | - | - +containerName | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - +divisor | [Nullable](#nullable)<[NonEmpty](#nonempty)<[String](#string)>> | False | - | - +name | [EnvString](#envstring) | False | - | - resource | [Enum](#enum)('limits.cpu', 'limits.memory', 'requests.cpu', 'requests.memory') | False | - | - ## ContainerEnvPodFieldSpec ### Parents: @@ -420,9 +420,9 @@ resource | [Enum](#enum)('limits.cpu', 'limits.memory', 'requests.cpu', 'request Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -apiVersion | Nullable<[Enum](#enum)('v1')> | False | - | - -fieldPath | [Enum](#enum)('metadata.name', 'metadata.namespace', 'metadata.labels', 'metadata.annotations', 'spec.nodeName', 'spec.serviceAccountName', 'status.pod[IP](#ip)') | False | - | - -name | Env[String](#string) | False | - | - +apiVersion | [Nullable](#nullable)<[Enum](#enum)('v1')> | False | - | - +fieldPath | [Enum](#enum)('metadata.name', 'metadata.namespace', 'metadata.labels', 'metadata.annotations', 'spec.nodeName', 'spec.serviceAccountName', 'status.podIP') | False | - | - +name | [EnvString](#envstring) | False | - | - ## ContainerEnvSecretSpec ### Parents: - [ContainerEnvBaseSpec](#containerenvbasespec) @@ -434,8 +434,8 @@ name | Env[String](#string) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -key | NonEmpty<[String](#string)> | False | - | - -name | Env[String](#string) | False | - | - +key | [NonEmpty](#nonempty)<[String](#string)> | False | - | - +name | [EnvString](#envstring) | False | - | - secret_name | [Identifier](#identifier) | False | - | - ## ContainerEnvSpec ### Parents: @@ -448,7 +448,7 @@ secret_name | [Identifier](#identifier) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Env[String](#string) | False | - | - +name | [EnvString](#envstring) | False | - | - value | [String](#string) | False | - | - ## ContainerPort ### Parent types: @@ -457,10 +457,10 @@ value | [String](#string) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -containerPort | Positive<NonZero<[Integer](#integer)>> | False | - | - -hostIP | Nullable<[IP](#ip)> | False | - | - -hostPort | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -name | Nullable<[String](#string)> | False | - | - +containerPort | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - +hostIP | [Nullable](#nullable)<[IP](#ip)> | False | - | - +hostPort | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +name | [Nullable](#nullable)<[String](#string)> | False | - | - protocol | [Enum](#enum)('TCP', 'UDP') | False | - | - ## ContainerProbeBaseSpec ### Children: @@ -472,11 +472,11 @@ protocol | [Enum](#enum)('TCP', 'UDP') | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -failureThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -initialDelaySeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - -periodSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -successThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +failureThreshold | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +initialDelaySeconds | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - +periodSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +successThreshold | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +timeoutSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - ## ContainerProbeHTTPSpec ### Parents: - [ContainerProbeBaseSpec](#containerprobebasespec) @@ -486,15 +486,15 @@ timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>& Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -failureThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -host | Nullable<[Domain](#domain)> | False | - | - -initialDelaySeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - -path | NonEmpty<[Path](#path)> | False | - | - -periodSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -port | Positive<NonZero<[Integer](#integer)>> | False | <unknown transformation> | - -scheme | Nullable<[Enum](#enum)('HTTP', 'HTTPS')> | False | - | - -successThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +failureThreshold | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +host | [Nullable](#nullable)<[Domain](#domain)> | False | - | - +initialDelaySeconds | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - +path | [NonEmpty](#nonempty)<[Path](#path)> | False | - | - +periodSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +port | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | <unknown transformation> | - +scheme | [Nullable](#nullable)<[Enum](#enum)('HTTP', 'HTTPS')> | False | - | - +successThreshold | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +timeoutSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - ## ContainerProbeTCPPortSpec ### Parents: - [ContainerProbeBaseSpec](#containerprobebasespec) @@ -504,12 +504,12 @@ timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>& Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -failureThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -initialDelaySeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - -periodSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -port | Positive<NonZero<[Integer](#integer)>> | False | <unknown transformation> | - -successThreshold | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +failureThreshold | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +initialDelaySeconds | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - +periodSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +port | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | <unknown transformation> | - +successThreshold | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +timeoutSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - ## ContainerResourceEachSpec ### Parent types: - [ContainerResourceSpec](#containerresourcespec) @@ -517,8 +517,8 @@ timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>& Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -cpu | Nullable<Positive<NonZero<[Number](#number)>>> | False | <unknown transformation> | - -memory | Nullable<Memory> | False | - | - +cpu | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Number](#number)>>> | False | <unknown transformation> | - +memory | [Nullable](#nullable)<[Memory](#memory)> | False | - | - ## ContainerResourceSpec ### Parent types: - [ContainerSpec](#containerspec) @@ -530,8 +530,8 @@ memory | Nullable<Memory> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -limits | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - -requests | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - +limits | [[ContainerResourceEachSpec](#containerresourceeachspec)](#containerresourceeachspec) | False | - | - +requests | [[ContainerResourceEachSpec](#containerresourceeachspec)](#containerresourceeachspec) | False | - | - ## ContainerSpec ### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) @@ -542,20 +542,20 @@ requests | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -args | Nullable<List<[String](#string)>> | False | - | - -command | Nullable<List<[String](#string)>> | False | - | - -env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - -image | NonEmpty<[String](#string)> | False | - | - -imagePullPolicy | Nullable<[Enum](#enum)('Always', 'IfNotPresent')> | False | - | - -kind | Nullable<[Enum](#enum)('DockerImage')> | False | - | - -lifecycle | Nullable<[LifeCycle](#lifecycle)> | False | - | - -livenessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - -ports | Nullable<List<[ContainerPort](#containerport)>> | False | <unknown transformation> | - -readinessProbe | Nullable<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - -securityContext | Nullable<[SecurityContext](#securitycontext)> | False | - | - -terminationMessagePath | Nullable<NonEmpty<[Path](#path)>> | False | - | - -volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | <unknown transformation> | - +args | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - +command | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - +env | [Nullable](#nullable)<[List](#list)<[[ContainerEnvBaseSpec](#containerenvbasespec)](#containerenvbasespec)>> | False | <unknown transformation> | - +image | [NonEmpty](#nonempty)<[String](#string)> | False | - | - +imagePullPolicy | [Nullable](#nullable)<[Enum](#enum)('Always', 'IfNotPresent')> | False | - | - +kind | [Nullable](#nullable)<[Enum](#enum)('DockerImage')> | False | - | - +lifecycle | [Nullable](#nullable)<[[LifeCycle](#lifecycle)](#lifecycle)> | False | - | - +livenessProbe | [Nullable](#nullable)<[[ContainerProbeBaseSpec](#containerprobebasespec)](#containerprobebasespec)> | False | - | - +ports | [Nullable](#nullable)<[List](#list)<[[ContainerPort](#containerport)](#containerport)>> | False | <unknown transformation> | - +readinessProbe | [Nullable](#nullable)<[[ContainerProbeBaseSpec](#containerprobebasespec)](#containerprobebasespec)> | False | - | - +resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - +securityContext | [Nullable](#nullable)<[[SecurityContext](#securitycontext)](#securitycontext)> | False | - | - +terminationMessagePath | [Nullable](#nullable)<[NonEmpty](#nonempty)<[Path](#path)>> | False | - | - +volumeMounts | [Nullable](#nullable)<[List](#list)<[[ContainerVolumeMountSpec](#containervolumemountspec)](#containervolumemountspec)>> | False | <unknown transformation> | - ## ContainerVolumeMountSpec ### Parent types: - [ContainerSpec](#containerspec) @@ -565,8 +565,8 @@ volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemo Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | False | - | - -path | NonEmpty<[Path](#path)> | False | - | - -readOnly | Nullable<[Boolean](#boolean)> | False | - | - +path | [NonEmpty](#nonempty)<[Path](#path)> | False | - | - +readOnly | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - ## DCBaseUpdateStrategy ### Children: - [DCRecreateStrategy](#dcrecreatestrategy) @@ -578,10 +578,10 @@ readOnly | Nullable<[Boolean](#boolean)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -annotations | Map<[String](#string), [String](#string)> | False | - | - -labels | Map<[String](#string), [String](#string)> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +annotations | [Map](#map)<[String](#string), [String](#string)> | False | - | - +labels | [Map](#map)<[String](#string), [String](#string)> | False | - | - +resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - ## DCConfigChangeTrigger ### Parents: - [DCTrigger](#dctrigger) @@ -598,9 +598,9 @@ resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | Fa Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -command | Nullable<List<[String](#string)>> | False | - | - -environment | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - -image | NonEmpty<[String](#string)> | False | - | - +command | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - +environment | [Nullable](#nullable)<[List](#list)<[[ContainerEnvBaseSpec](#containerenvbasespec)](#containerenvbasespec)>> | False | <unknown transformation> | - +image | [NonEmpty](#nonempty)<[String](#string)> | False | - | - ## DCCustomStrategy ### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) @@ -610,11 +610,11 @@ image | NonEmpty<[String](#string)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -annotations | Map<[String](#string), [String](#string)> | False | - | - -customParams | [DCCustomParams](#dccustomparams) | False | - | - -labels | Map<[String](#string), [String](#string)> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +annotations | [Map](#map)<[String](#string), [String](#string)> | False | - | - +customParams | [[DCCustomParams](#dccustomparams)](#dccustomparams) | False | - | - +labels | [Map](#map)<[String](#string), [String](#string)> | False | - | - +resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - ## DCImageChangeTrigger ### Parents: - [DCTrigger](#dctrigger) @@ -628,9 +628,9 @@ resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | Fa Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -execNewPod | Nullable<[DCLifecycleNewPod](#dclifecyclenewpod)> | False | - | - +execNewPod | [Nullable](#nullable)<[[DCLifecycleNewPod](#dclifecyclenewpod)](#dclifecyclenewpod)> | False | - | - failurePolicy | [Enum](#enum)('Abort', 'Retry', 'Ignore') | False | - | - -tagImages | Nullable<[DCTagImages](#dctagimages)> | False | - | - +tagImages | [Nullable](#nullable)<[[DCTagImages](#dctagimages)](#dctagimages)> | False | - | - ## DCLifecycleNewPod ### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) @@ -640,11 +640,11 @@ tagImages | Nullable<[DCTagImages](#dctagimages)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -command | NonEmpty<List<[String](#string)>> | False | - | - +command | [NonEmpty](#nonempty)<[List](#list)<[String](#string)>> | False | - | - containerName | [Identifier](#identifier) | False | - | - -env | Nullable<List<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - -volumeMounts | Nullable<List<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | - | - -volumes | Nullable<List<[Identifier](#identifier)>> | False | - | - +env | [Nullable](#nullable)<[List](#list)<[[ContainerEnvBaseSpec](#containerenvbasespec)](#containerenvbasespec)>> | False | <unknown transformation> | - +volumeMounts | [Nullable](#nullable)<[List](#list)<[[ContainerVolumeMountSpec](#containervolumemountspec)](#containervolumemountspec)>> | False | - | - +volumes | [Nullable](#nullable)<[List](#list)<[Identifier](#identifier)>> | False | - | - ## DCRecreateParams ### Parent types: - [DCRecreateStrategy](#dcrecreatestrategy) @@ -652,10 +652,10 @@ volumes | Nullable<List<[Identifier](#identifier)>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -mid | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +mid | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - +post | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - +pre | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - +timeoutSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - ## DCRecreateStrategy ### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) @@ -665,12 +665,12 @@ timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>& Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -annotations | Map<[String](#string), [String](#string)> | False | - | - -customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - -labels | Map<[String](#string), [String](#string)> | False | - | - -recreateParams | Nullable<[DCRecreateParams](#dcrecreateparams)> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +annotations | [Map](#map)<[String](#string), [String](#string)> | False | - | - +customParams | [Nullable](#nullable)<[[DCCustomParams](#dccustomparams)](#dccustomparams)> | False | - | - +labels | [Map](#map)<[String](#string), [String](#string)> | False | - | - +recreateParams | [Nullable](#nullable)<[[DCRecreateParams](#dcrecreateparams)](#dcrecreateparams)> | False | - | - +resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - ## DCRollingParams ### Parent types: - [DCRollingStrategy](#dcrollingstrategy) @@ -678,13 +678,13 @@ resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | Fa Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -intervalSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +intervalSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - maxSurge | [SurgeSpec](#surgespec) | False | - | - maxUnavailable | [SurgeSpec](#surgespec) | False | - | - -post | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -pre | Nullable<[DCLifecycleHook](#dclifecyclehook)> | False | - | - -timeoutSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -updatePeriodSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +post | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - +pre | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - +timeoutSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +updatePeriodSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - ## DCRollingStrategy ### Parents: - [DCBaseUpdateStrategy](#dcbaseupdatestrategy) @@ -694,12 +694,12 @@ updatePeriodSeconds | Nullable<Positive<NonZero<[Integer](#integer)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -activeDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -annotations | Map<[String](#string), [String](#string)> | False | - | - -customParams | Nullable<[DCCustomParams](#dccustomparams)> | False | - | - -labels | Map<[String](#string), [String](#string)> | False | - | - -resources | Nullable<[ContainerResourceSpec](#containerresourcespec)> | False | - | - -rollingParams | Nullable<[DCRollingParams](#dcrollingparams)> | False | - | - +activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +annotations | [Map](#map)<[String](#string), [String](#string)> | False | - | - +customParams | [Nullable](#nullable)<[[DCCustomParams](#dccustomparams)](#dccustomparams)> | False | - | - +labels | [Map](#map)<[String](#string), [String](#string)> | False | - | - +resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - +rollingParams | [Nullable](#nullable)<[[DCRollingParams](#dcrollingparams)](#dcrollingparams)> | False | - | - ## DCTagImages ### Parent types: - [DCLifecycleHook](#dclifecyclehook) @@ -708,13 +708,13 @@ rollingParams | Nullable<[DCRollingParams](#dcrollingparams)> | False | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- containerName | [Identifier](#identifier) | False | - | - -toApiVersion | Nullable<[String](#string)> | False | - | - -toFieldPath | Nullable<[String](#string)> | False | - | - -toKind | Nullable<[Enum](#enum)('Deployment', 'DeploymentConfig', 'ImageStreamTag')> | False | - | - -toName | Nullable<[Identifier](#identifier)> | False | - | - -toNamespace | Nullable<[Identifier](#identifier)> | False | - | - -toResourceVersion | Nullable<[String](#string)> | False | - | - -toUid | Nullable<[String](#string)> | False | - | - +toApiVersion | [Nullable](#nullable)<[String](#string)> | False | - | - +toFieldPath | [Nullable](#nullable)<[String](#string)> | False | - | - +toKind | [Nullable](#nullable)<[Enum](#enum)('Deployment', 'DeploymentConfig', 'ImageStreamTag')> | False | - | - +toName | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - +toNamespace | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - +toResourceVersion | [Nullable](#nullable)<[String](#string)> | False | - | - +toUid | [Nullable](#nullable)<[String](#string)> | False | - | - ## DCTrigger ### Children: - [DCConfigChangeTrigger](#dcconfigchangetrigger) @@ -727,15 +727,15 @@ toUid | Nullable<[String](#string)> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -selector | Nullable<[BaseSelector](#baseselector)> | False | <unknown transformation> | - +pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - +selector | [Nullable](#nullable)<[[BaseSelector](#baseselector)](#baseselector)> | False | <unknown transformation> | - ## [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) @@ -747,57 +747,57 @@ You can define Deployments to create new ReplicaSets, or to remove existing Depl ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -minReadySeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -paused | Nullable<[Boolean](#boolean)> | False | - | - -pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -progressDeadlineSeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -replicas | Positive<NonZero<[Integer](#integer)>> | False | - | - -revisionHistoryLimit | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -selector | Nullable<[BaseSelector](#baseselector)> | False | - | - -strategy | Nullable<[DplBaseUpdateStrategy](#dplbaseupdatestrategy)> | False | - | - +minReadySeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +paused | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - +pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - +progressDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +replicas | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - +revisionHistoryLimit | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +selector | [Nullable](#nullable)<[[BaseSelector](#baseselector)](#baseselector)> | False | - | - +strategy | [Nullable](#nullable)<[[DplBaseUpdateStrategy](#dplbaseupdatestrategy)](#dplbaseupdatestrategy)> | False | - | - ## DeploymentConfig ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -minReadySeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -paused | Nullable<[Boolean](#boolean)> | False | - | - -pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -replicas | Positive<NonZero<[Integer](#integer)>> | False | - | - -revisionHistoryLimit | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -selector | Nullable<Map<[String](#string), [String](#string)>> | False | - | - -strategy | [DCBaseUpdateStrategy](#dcbaseupdatestrategy) | False | - | - +minReadySeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +paused | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - +pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - +replicas | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - +revisionHistoryLimit | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +selector | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - +strategy | [[DCBaseUpdateStrategy](#dcbaseupdatestrategy)](#dcbaseupdatestrategy) | False | - | - test | [Boolean](#boolean) | False | - | - -triggers | List<[DCTrigger](#dctrigger)> | False | - | - +triggers | [List](#list)<[[DCTrigger](#dctrigger)](#dctrigger)> | False | - | - ## DockerCredentials ### Parents: - [Secret](#secret) ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -dockers | Map<[String](#string), Map<[String](#string), [String](#string)>> | False | - | - -secrets | Map<[String](#string), [String](#string)> | False | - | - -type | NonEmpty<[String](#string)> | False | - | - +dockers | [Map](#map)<[String](#string), [Map](#map)<[String](#string), [String](#string)>> | False | - | - +secrets | [Map](#map)<[String](#string), [String](#string)> | False | - | - +type | [NonEmpty](#nonempty)<[String](#string)> | False | - | - ## DplBaseUpdateStrategy ### Children: - [DplRecreateStrategy](#dplrecreatestrategy) @@ -824,31 +824,31 @@ maxUnavailable | [SurgeSpec](#surgespec) | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -users | NonEmpty<List<User[Identifier](#identifier)>> | False | - | - +users | [NonEmpty](#nonempty)<[List](#list)<[UserIdentifier](#useridentifier)>> | False | - | - ## Job ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -activeDeadlineSeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - -completions | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -manualSelector | Nullable<[Boolean](#boolean)> | False | - | - -parallelism | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -selector | Nullable<[BaseSelector](#baseselector)> | False | - | - +activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - +completions | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +manualSelector | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - +parallelism | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - +selector | [Nullable](#nullable)<[[BaseSelector](#baseselector)](#baseselector)> | False | - | - ## LifeCycle ### Parent types: - [ContainerSpec](#containerspec) @@ -856,8 +856,8 @@ selector | Nullable<[BaseSelector](#baseselector)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -postStart | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - -preStop | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - +postStart | [Nullable](#nullable)<[[LifeCycleProbe](#lifecycleprobe)](#lifecycleprobe)> | False | - | - +preStop | [Nullable](#nullable)<[[LifeCycleProbe](#lifecycleprobe)](#lifecycleprobe)> | False | - | - ## LifeCycleExec ### Parents: - [LifeCycleProbe](#lifecycleprobe) @@ -867,7 +867,7 @@ preStop | Nullable<[LifeCycleProbe](#lifecycleprobe)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -command | NonEmpty<List<[String](#string)>> | False | - | - +command | [NonEmpty](#nonempty)<[List](#list)<[String](#string)>> | False | - | - ## LifeCycleHTTP ### Parents: - [LifeCycleProbe](#lifecycleprobe) @@ -877,9 +877,9 @@ command | NonEmpty<List<[String](#string)>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -path | NonEmpty<[Path](#path)> | False | - | - -port | Positive<NonZero<[Integer](#integer)>> | False | - | - -scheme | Nullable<[Enum](#enum)('HTTP', 'HTTPS')> | False | - | - +path | [NonEmpty](#nonempty)<[Path](#path)> | False | - | - +port | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - +scheme | [Nullable](#nullable)<[Enum](#enum)('HTTP', 'HTTPS')> | False | - | - ## LifeCycleProbe ### Children: - [LifeCycleExec](#lifecycleexec) @@ -893,9 +893,9 @@ scheme | Nullable<[Enum](#enum)('HTTP', 'HTTPS')> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -key | NonEmpty<[String](#string)> | False | - | - +key | [NonEmpty](#nonempty)<[String](#string)> | False | - | - operator | [Enum](#enum)('In', 'NotIn', 'Exists', 'DoesNotExist') | False | - | - -values | Nullable<List<[String](#string)>> | False | - | - +values | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - ## MatchExpressionsSelector ### Parents: - [BaseSelector](#baseselector) @@ -908,7 +908,7 @@ values | Nullable<List<[String](#string)>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -matchExpressions | NonEmpty<List<[MatchExpression](#matchexpression)>> | False | - | - +matchExpressions | [NonEmpty](#nonempty)<[List](#list)<[[MatchExpression](#matchexpression)](#matchexpression)>> | False | - | - ## MatchLabelsSelector ### Parents: - [BaseSelector](#baseselector) @@ -921,15 +921,15 @@ matchExpressions | NonEmpty<List<[MatchExpression](#matchexpression)>&g Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -matchLabels | Map<[String](#string), [String](#string)> | False | - | - +matchLabels | [Map](#map)<[String](#string), [String](#string)> | False | - | - ## Namespace ### Children: - [Project](#project) ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -939,33 +939,33 @@ name | [Identifier](#identifier) | True | - | - ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -accessModes | List<[Enum](#enum)('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - -awsElasticBlockStore | Nullable<[AWSElasticBlockStore](#awselasticblockstore)> | False | - | - -capacity | Memory | False | - | - -claimRef | Nullable<[PersistentVolumeRef](#persistentvolumeref)> | False | - | - -persistentVolumeReclaimPolicy | Nullable<[Enum](#enum)('Retain', 'Recycle', 'Delete')> | False | - | - +accessModes | [List](#list)<[Enum](#enum)('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - +awsElasticBlockStore | [Nullable](#nullable)<[[AWSElasticBlockStore](#awselasticblockstore)](#awselasticblockstore)> | False | - | - +capacity | [Memory](#memory) | False | - | - +claimRef | [Nullable](#nullable)<[[PersistentVolumeRef](#persistentvolumeref)](#persistentvolumeref)> | False | - | - +persistentVolumeReclaimPolicy | [Nullable](#nullable)<[Enum](#enum)('Retain', 'Recycle', 'Delete')> | False | - | - ## PersistentVolumeClaim ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -accessModes | List<[Enum](#enum)('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - -request | Memory | False | - | - -selector | Nullable<[BaseSelector](#baseselector)> | False | - | - -volumeName | Nullable<[Identifier](#identifier)> | False | <unknown transformation> | - +accessModes | [List](#list)<[Enum](#enum)('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - +request | [Memory](#memory) | False | - | - +selector | [Nullable](#nullable)<[[BaseSelector](#baseselector)](#baseselector)> | False | - | - +volumeName | [Nullable](#nullable)<[Identifier](#identifier)> | False | <unknown transformation> | - ## PersistentVolumeRef ### Parent types: - [PersistentVolume](#persistentvolume) @@ -973,10 +973,10 @@ volumeName | Nullable<[Identifier](#identifier)> | False | <unknown tra Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -apiVersion | Nullable<[String](#string)> | False | - | - -kind | Nullable<[Case[Identifier](#identifier)](#caseidentifier)> | False | - | - -name | Nullable<[Identifier](#identifier)> | False | - | - -ns | Nullable<[Identifier](#identifier)> | False | - | - +apiVersion | [Nullable](#nullable)<[String](#string)> | False | - | - +kind | [Nullable](#nullable)<[CaseIdentifier](#caseidentifier)> | False | - | - +name | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - +ns | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - ## PodImagePullSecret ### Parent types: - [PodTemplateSpec](#podtemplatespec) @@ -995,25 +995,25 @@ name | [Identifier](#identifier) | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -containers | NonEmpty<List<[ContainerSpec](#containerspec)>> | False | - | - -dnsPolicy | Nullable<[Enum](#enum)('ClusterFirst')> | False | - | - -hostIPC | Nullable<[Boolean](#boolean)> | False | - | - -hostNetwork | Nullable<[Boolean](#boolean)> | False | - | - -hostPID | Nullable<[Boolean](#boolean)> | False | - | - -imagePullSecrets | Nullable<List<[PodImagePullSecret](#podimagepullsecret)>> | False | <unknown transformation> | - -name | Nullable<[Identifier](#identifier)> | False | - | - -nodeSelector | Nullable<Map<[String](#string), [String](#string)>> | False | - | - -restartPolicy | Nullable<[Enum](#enum)('Always', 'OnFailure', 'Never')> | False | - | - -securityContext | Nullable<[SecurityContext](#securitycontext)> | False | - | - -serviceAccountName | Nullable<[Identifier](#identifier)> | False | <unknown transformation> | [serviceAccount](#serviceaccount) -terminationGracePeriodSeconds | Nullable<Positive<[Integer](#integer)>> | False | - | - -volumes | Nullable<List<[PodVolumeBaseSpec](#podvolumebasespec)>> | False | - | - +containers | [NonEmpty](#nonempty)<[List](#list)<[[ContainerSpec](#containerspec)](#containerspec)>> | False | - | - +dnsPolicy | [Nullable](#nullable)<[Enum](#enum)('ClusterFirst')> | False | - | - +hostIPC | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - +hostNetwork | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - +hostPID | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - +imagePullSecrets | [Nullable](#nullable)<[List](#list)<[[PodImagePullSecret](#podimagepullsecret)](#podimagepullsecret)>> | False | <unknown transformation> | - +name | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - +nodeSelector | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - +restartPolicy | [Nullable](#nullable)<[Enum](#enum)('Always', 'OnFailure', 'Never')> | False | - | - +securityContext | [Nullable](#nullable)<[[SecurityContext](#securitycontext)](#securitycontext)> | False | - | - +serviceAccountName | [Nullable](#nullable)<[Identifier](#identifier)> | False | <unknown transformation> | [serviceAccount](#serviceaccount) +terminationGracePeriodSeconds | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - +volumes | [Nullable](#nullable)<[List](#list)<[[PodVolumeBaseSpec](#podvolumebasespec)](#podvolumebasespec)>> | False | - | - ## PodVolumeBaseSpec ### Children: - [PodVolumeHostSpec](#podvolumehostspec) @@ -1039,8 +1039,8 @@ name | [Identifier](#identifier) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -defaultMode | Nullable<Positive<[Integer](#integer)>> | False | - | - -item_map | Nullable<Map<[String](#string), [String](#string)>> | False | - | - +defaultMode | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - +item_map | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - map_name | [Identifier](#identifier) | False | - | - name | [Identifier](#identifier) | False | - | - ## PodVolumeEmptyDirSpec @@ -1076,7 +1076,7 @@ path | [String](#string) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -item_map | Nullable<Map<[String](#string), [String](#string)>> | False | - | - +item_map | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - name | [Identifier](#identifier) | False | - | - ## PodVolumePVCSpec ### Parents: @@ -1099,22 +1099,22 @@ name | [Identifier](#identifier) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -defaultMode | Nullable<Positive<[Integer](#integer)>> | False | - | - -item_map | Nullable<Map<[String](#string), [String](#string)>> | False | - | - +defaultMode | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - +item_map | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - name | [Identifier](#identifier) | False | - | - secret_name | [Identifier](#identifier) | False | - | - ## PolicyBinding ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [ColonIdentifier](#colonidentifier) | True | - | - -roleBindings | List<[PolicyBindingRoleBinding](#policybindingrolebinding)> | False | <unknown transformation> | - +roleBindings | [List](#list)<[[PolicyBindingRoleBinding](#policybindingrolebinding)](#policybindingrolebinding)> | False | <unknown transformation> | - ## PolicyBindingRoleBinding ### Parents: - [RoleBindingXF](#rolebindingxf) @@ -1124,11 +1124,11 @@ roleBindings | List<[PolicyBindingRoleBinding](#policybindingrolebinding)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -metadata | Nullable<Map<[String](#string), [String](#string)>> | False | - | - -name | System[Identifier](#identifier) | False | - | - +metadata | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - +name | [SystemIdentifier](#systemidentifier) | False | - | - ns | [Identifier](#identifier) | False | - | - -roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - -subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - +roleRef | [[RoleRef](#roleref)](#roleref) | False | <unknown transformation> | - +subjects | [NonEmpty](#nonempty)<[List](#list)<[[RoleSubject](#rolesubject)](#rolesubject)>> | False | <unknown transformation> | - ## PolicyRule ### Parent types: - [ClusterRole](#clusterrole) @@ -1138,20 +1138,20 @@ subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | < Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -apiGroups | NonEmpty<List<[String](#string)>> | False | - | - -attributeRestrictions | Nullable<[String](#string)> | False | - | - -nonResourceURLs | Nullable<List<[String](#string)>> | False | - | - -resourceNames | Nullable<List<[String](#string)>> | False | - | - -resources | NonEmpty<List<NonEmpty<[String](#string)>>> | False | - | - -verbs | NonEmpty<List<[Enum](#enum)('get', 'list', 'create', 'update', 'delete', 'deletecollection', 'watch')>> | False | - | - +apiGroups | [NonEmpty](#nonempty)<[List](#list)<[String](#string)>> | False | - | - +attributeRestrictions | [Nullable](#nullable)<[String](#string)> | False | - | - +nonResourceURLs | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - +resourceNames | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - +resources | [NonEmpty](#nonempty)<[List](#list)<[NonEmpty](#nonempty)<[String](#string)>>> | False | - | - +verbs | [NonEmpty](#nonempty)<[List](#list)<[Enum](#enum)('get', 'list', 'create', 'update', 'delete', 'deletecollection', 'watch')>> | False | - | - ## Project ### Parents: - [Namespace](#namespace) ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1161,31 +1161,31 @@ name | [Identifier](#identifier) | True | - | - ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -minReadySeconds | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - -replicas | Positive<NonZero<[Integer](#integer)>> | False | - | - -selector | Nullable<Map<[String](#string), [String](#string)>> | False | - | - +minReadySeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - +replicas | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - +selector | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - ## Role ### Parents: - [RoleBase](#rolebase) ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - +rules | [NonEmpty](#nonempty)<[List](#list)<[[PolicyRule](#policyrule)](#policyrule)>> | False | - | - ## RoleBinding ### Parents: - [RoleBindingBase](#rolebindingbase) @@ -1193,15 +1193,15 @@ rules | NonEmpty<List<[PolicyRule](#policyrule)>> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [SystemIdentifier](#systemidentifier) | True | - | - -roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - -subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - +roleRef | [[RoleRef](#roleref)](#roleref) | False | <unknown transformation> | - +subjects | [NonEmpty](#nonempty)<[List](#list)<[[RoleSubject](#rolesubject)](#rolesubject)>> | False | <unknown transformation> | - ## RoleRef ### Parent types: - [ClusterRoleBinding](#clusterrolebinding) @@ -1212,8 +1212,8 @@ subjects | NonEmpty<List<[RoleSubject](#rolesubject)>> | False | < Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Nullable<System[Identifier](#identifier)> | False | - | - -ns | Nullable<[Identifier](#identifier)> | False | - | - +name | [Nullable](#nullable)<[SystemIdentifier](#systemidentifier)> | False | - | - +ns | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - ## RoleSubject ### Parent types: - [ClusterRoleBinding](#clusterrolebinding) @@ -1224,24 +1224,24 @@ ns | Nullable<[Identifier](#identifier)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -kind | [Case[Identifier](#identifier)](#caseidentifier) | False | - | - +kind | [CaseIdentifier](#caseidentifier) | False | - | - name | [String](#string) | False | - | - -ns | Nullable<[Identifier](#identifier)> | False | - | - +ns | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - ## Route ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - host | [Domain](#domain) | False | - | - -port | [RouteDestPort](#routedestport) | False | - | - -tls | Nullable<[RouteTLS](#routetls)> | False | - | - -to | NonEmpty<List<[RouteDest](#routedest)>> | False | - | - +port | [[RouteDestPort](#routedestport)](#routedestport) | False | - | - +tls | [Nullable](#nullable)<[[RouteTLS](#routetls)](#routetls)> | False | - | - +to | [NonEmpty](#nonempty)<[List](#list)<[[RouteDest](#routedest)](#routedest)>> | False | - | - wildcardPolicy | [Enum](#enum)('Subdomain', 'None') | False | - | - ## RouteDest ### Children: @@ -1252,7 +1252,7 @@ wildcardPolicy | [Enum](#enum)('Subdomain', 'None') | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -weight | Positive<NonZero<[Integer](#integer)>> | False | - | - +weight | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - ## RouteDestPort ### Parent types: - [Route](#route) @@ -1271,7 +1271,7 @@ targetPort | [Identifier](#identifier) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | False | - | - -weight | Positive<NonZero<[Integer](#integer)>> | False | - | - +weight | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - ## RouteTLS ### Parent types: - [Route](#route) @@ -1279,11 +1279,11 @@ weight | Positive<NonZero<[Integer](#integer)>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -caCertificate | Nullable<NonEmpty<[String](#string)>> | False | - | - -certificate | Nullable<NonEmpty<[String](#string)>> | False | - | - -destinationCACertificate | Nullable<NonEmpty<[String](#string)>> | False | - | - +caCertificate | [Nullable](#nullable)<[NonEmpty](#nonempty)<[String](#string)>> | False | - | - +certificate | [Nullable](#nullable)<[NonEmpty](#nonempty)<[String](#string)>> | False | - | - +destinationCACertificate | [Nullable](#nullable)<[NonEmpty](#nonempty)<[String](#string)>> | False | - | - insecureEdgeTerminationPolicy | [Enum](#enum)('Allow', 'Disable', 'Redirect') | False | - | - -key | Nullable<NonEmpty<[String](#string)>> | False | - | - +key | [Nullable](#nullable)<[NonEmpty](#nonempty)<[String](#string)>> | False | - | - termination | [Enum](#enum)('edge', 'reencrypt', 'passthrough') | False | - | - ## SAImgPullSecretSubject ### Parent types: @@ -1300,9 +1300,9 @@ name | [Identifier](#identifier) | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -kind | Nullable<[Case[Identifier](#identifier)](#caseidentifier)> | False | - | - -name | Nullable<[Identifier](#identifier)> | False | - | - -ns | Nullable<[Identifier](#identifier)> | False | - | - +kind | [Nullable](#nullable)<[CaseIdentifier](#caseidentifier)> | False | - | - +name | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - +ns | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - ## SCCGroupRange ### Parent types: - [SCCGroups](#sccgroups) @@ -1310,8 +1310,8 @@ ns | Nullable<[Identifier](#identifier)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -max | Positive<NonZero<[Integer](#integer)>> | False | - | - -min | Positive<NonZero<[Integer](#integer)>> | False | - | - +max | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - +min | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - ## SCCGroups ### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) @@ -1319,8 +1319,8 @@ min | Positive<NonZero<[Integer](#integer)>> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -ranges | Nullable<List<[SCCGroupRange](#sccgrouprange)>> | False | - | - -type | Nullable<[Enum](#enum)('MustRunAs', 'RunAsAny')> | False | - | - +ranges | [Nullable](#nullable)<[List](#list)<[[SCCGroupRange](#sccgrouprange)](#sccgrouprange)>> | False | - | - +type | [Nullable](#nullable)<[Enum](#enum)('MustRunAs', 'RunAsAny')> | False | - | - ## SCCRunAsUser ### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) @@ -1329,9 +1329,9 @@ type | Nullable<[Enum](#enum)('MustRunAs', 'RunAsAny')> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- type | [Enum](#enum)('MustRunAs', 'RunAsAny', 'MustRunAsRange', 'MustRunAsNonRoot') | False | - | - -uid | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -uidRangeMax | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - -uidRangeMin | Nullable<Positive<NonZero<[Integer](#integer)>>> | False | - | - +uid | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +uidRangeMax | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - +uidRangeMin | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - ## SCCSELinux ### Parent types: - [SecurityContextConstraints](#securitycontextconstraints) @@ -1339,11 +1339,11 @@ uidRangeMin | Nullable<Positive<NonZero<[Integer](#integer)>>> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -level | Nullable<[String](#string)> | False | - | - -role | Nullable<[String](#string)> | False | - | - -strategy | Nullable<[Enum](#enum)('MustRunAs', 'RunAsAny')> | False | - | - -type | Nullable<[String](#string)> | False | - | - -user | Nullable<[String](#string)> | False | - | - +level | [Nullable](#nullable)<[String](#string)> | False | - | - +role | [Nullable](#nullable)<[String](#string)> | False | - | - +strategy | [Nullable](#nullable)<[Enum](#enum)('MustRunAs', 'RunAsAny')> | False | - | - +type | [Nullable](#nullable)<[String](#string)> | False | - | - +user | [Nullable](#nullable)<[String](#string)> | False | - | - ## Secret ### Children: - [DockerCredentials](#dockercredentials) @@ -1351,15 +1351,15 @@ user | Nullable<[String](#string)> | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -secrets | Map<[String](#string), [String](#string)> | False | - | - -type | NonEmpty<[String](#string)> | False | - | - +secrets | [Map](#map)<[String](#string), [String](#string)> | False | - | - +type | [NonEmpty](#nonempty)<[String](#string)> | False | - | - ## SecurityContext ### Parent types: - [ContainerSpec](#containerspec) @@ -1368,17 +1368,17 @@ type | NonEmpty<[String](#string)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -fsGroup | Nullable<[Integer](#integer)> | False | - | - -privileged | Nullable<[Boolean](#boolean)> | False | - | - -runAsNonRoot | Nullable<[Boolean](#boolean)> | False | - | - -runAsUser | Nullable<[Integer](#integer)> | False | - | - -supplementalGroups | Nullable<List<[Integer](#integer)>> | False | - | - +fsGroup | [Nullable](#nullable)<[Integer](#integer)> | False | - | - +privileged | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - +runAsNonRoot | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - +runAsUser | [Nullable](#nullable)<[Integer](#integer)> | False | - | - +supplementalGroups | [Nullable](#nullable)<[List](#list)<[Integer](#integer)>> | False | - | - ## SecurityContextConstraints ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases @@ -1390,19 +1390,19 @@ allowHostNetwork | [Boolean](#boolean) | False | - | - allowHostPID | [Boolean](#boolean) | False | - | - allowHostPorts | [Boolean](#boolean) | False | - | - allowPrivilegedContainer | [Boolean](#boolean) | False | - | - -allowedCapabilities | Nullable<List<[String](#string)>> | False | - | - -defaultAddCapabilities | Nullable<List<[String](#string)>> | False | - | - -fsGroup | Nullable<[SCCGroups](#sccgroups)> | False | - | - -groups | List<System[Identifier](#identifier)> | False | - | - -priority | Nullable<Positive<[Integer](#integer)>> | False | - | - +allowedCapabilities | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - +defaultAddCapabilities | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - +fsGroup | [Nullable](#nullable)<[[SCCGroups](#sccgroups)](#sccgroups)> | False | - | - +groups | [List](#list)<[SystemIdentifier](#systemidentifier)> | False | - | - +priority | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - readOnlyRootFilesystem | [Boolean](#boolean) | False | - | - -requiredDropCapabilities | Nullable<List<[String](#string)>> | False | - | - -runAsUser | Nullable<[SCCRunAsUser](#sccrunasuser)> | False | - | - -seLinuxContext | Nullable<[SCCSELinux](#sccselinux)> | False | - | - -seccompProfiles | Nullable<List<[String](#string)>> | False | - | - -supplementalGroups | Nullable<[SCCGroups](#sccgroups)> | False | - | - -users | List<System[Identifier](#identifier)> | False | - | - -volumes | List<[Enum](#enum)('configMap', 'downwardAPI', 'emptyDir', 'host[Path](#path)', 'nfs', 'persistentVolumeClaim', 'secret', '*')> | False | - | - +requiredDropCapabilities | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - +runAsUser | [Nullable](#nullable)<[[SCCRunAsUser](#sccrunasuser)](#sccrunasuser)> | False | - | - +seLinuxContext | [Nullable](#nullable)<[[SCCSELinux](#sccselinux)](#sccselinux)> | False | - | - +seccompProfiles | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - +supplementalGroups | [Nullable](#nullable)<[[SCCGroups](#sccgroups)](#sccgroups)> | False | - | - +users | [List](#list)<[SystemIdentifier](#systemidentifier)> | False | - | - +volumes | [List](#list)<[Enum](#enum)('configMap', 'downwardAPI', 'emptyDir', 'hostPath', 'nfs', 'persistentVolumeClaim', 'secret', '*')> | False | - | - ## Service ### Children: - [ClusterIPService](#clusteripservice) @@ -1410,29 +1410,29 @@ volumes | List<[Enum](#enum)('configMap', 'downwardAPI', 'emptyDir', 'host[Pa ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -ports | NonEmpty<List<[ServicePort](#serviceport)>> | False | <unknown transformation> | - -selector | NonEmpty<Map<[String](#string), [String](#string)>> | False | <unknown transformation> | - -sessionAffinity | Nullable<[Enum](#enum)('Client[IP](#ip)', 'None')> | False | - | - +ports | [NonEmpty](#nonempty)<[List](#list)<[[ServicePort](#serviceport)](#serviceport)>> | False | <unknown transformation> | - +selector | [NonEmpty](#nonempty)<[Map](#map)<[String](#string), [String](#string)>> | False | <unknown transformation> | - +sessionAffinity | [Nullable](#nullable)<[Enum](#enum)('ClientIP', 'None')> | False | - | - ## ServiceAccount ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -imagePullSecrets | Nullable<List<[SAImgPullSecretSubject](#saimgpullsecretsubject)>> | False | <unknown transformation> | - -secrets | Nullable<List<[SASecretSubject](#sasecretsubject)>> | False | <unknown transformation> | - +imagePullSecrets | [Nullable](#nullable)<[List](#list)<[[SAImgPullSecretSubject](#saimgpullsecretsubject)](#saimgpullsecretsubject)>> | False | <unknown transformation> | - +secrets | [Nullable](#nullable)<[List](#list)<[[SASecretSubject](#sasecretsubject)](#sasecretsubject)>> | False | <unknown transformation> | - ## ServicePort ### Parent types: - [AWSLoadBalancerService](#awsloadbalancerservice) @@ -1442,22 +1442,22 @@ secrets | Nullable<List<[SASecretSubject](#sasecretsubject)>> | Fals Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -name | Nullable<[Identifier](#identifier)> | False | - | - -port | Positive<NonZero<[Integer](#integer)>> | False | - | - +name | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - +port | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - protocol | [Enum](#enum)('TCP', 'UDP') | False | - | - -targetPort | OneOf<Positive<NonZero<[Integer](#integer)>>, [Identifier](#identifier)> | False | - | - +targetPort | [OneOf](#<built-in method lower of str object at 0x10a459bd0>)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>, [Identifier](#identifier)> | False | - | - ## StorageClass ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -parameters | Map<[String](#string), [String](#string)> | False | - | - +parameters | [Map](#map)<[String](#string), [String](#string)> | False | - | - provisioner | [String](#string) | False | - | - ## TLSCredentials ### Parents: @@ -1465,27 +1465,27 @@ provisioner | [String](#string) | False | - | - ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -secrets | Map<[String](#string), [String](#string)> | False | - | - +secrets | [Map](#map)<[String](#string), [String](#string)> | False | - | - tls_cert | [String](#string) | False | - | - tls_key | [String](#string) | False | - | - -type | NonEmpty<[String](#string)> | False | - | - +type | [NonEmpty](#nonempty)<[String](#string)> | False | - | - ## User ### Metadata Name | Format ---- | ------ -annotations | Map<[String](#string), [String](#string)> -labels | Map<[String](#string), [String](#string)> +annotations | [Map](#map)<[String](#string), [String](#string)> +labels | [Map](#map)<[String](#string), [String](#string)> ### Properties: Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [UserIdentifier](#useridentifier) | True | - | - -fullName | Nullable<[String](#string)> | False | - | - -identities | NonEmpty<List<NonEmpty<[String](#string)>>> | False | - | - +fullName | [Nullable](#nullable)<[String](#string)> | False | - | - +identities | [NonEmpty](#nonempty)<[List](#list)<[NonEmpty](#nonempty)<[String](#string)>>> | False | - | - diff --git a/lib/kube_help.py b/lib/kube_help.py index 5479aec..a56d4b5 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -158,8 +158,8 @@ def render_markdown(self, links=[]): txt += '### Metadata\n' txt += 'Name | Format\n' txt += '---- | ------\n' - txt += 'annotations | {}\n'.format(self._decorate_obj_links(Map(String, String).name(), links)) - txt += 'labels | {}\n'.format(self._decorate_obj_links(Map(String, String).name(), links)) + txt += 'annotations | {}\n'.format(Map(String, String).name(md=True)) + txt += 'labels | {}\n'.format(Map(String, String).name(md=True)) # Properties table if len(self.class_types.keys()) == 0: @@ -183,7 +183,7 @@ def render_markdown(self, links=[]): is_mapped = ', '.join(self._get_markdown_link(self.class_mapping[p])) if p in self.class_mapping else '-' original_type = self.class_types[p].original_type() - display_type = self.class_types[p].name().replace('<', '<').replace('>', '>') + display_type = self.class_types[p].name(md=True).replace('<', '<').replace('>', '>') if original_type is not None: if isinstance(original_type, list): @@ -192,7 +192,7 @@ def render_markdown(self, links=[]): original_type = original_type['value'] classname = original_type.__name__ display_type = display_type.replace(classname, self._get_markdown_link(classname)) - display_type = self._decorate_obj_links(display=display_type, links=links) + # display_type = self._decorate_obj_links(display=display_type, links=links) txt += '{} | {} | False | {} | {} \n'.format(p, display_type, xf_data, is_mapped) diff --git a/lib/kube_types.py b/lib/kube_types.py index 2f15d1a..af6680d 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -64,9 +64,14 @@ def original_type(self): return self.wrap.original_type() return None - def name(self): + def name(self, md=False): if self.wrapper: - return '{}<{}>'.format(self.__class__.__name__, self.wrap.name()) + if md: + return '[{}](#{})<{}>'.format(self.__class__.__name__, self.__class__.__name__.lower(), self.wrap.name(md=True)) + else: + return '{}<{}>'.format(self.__class__.__name__, self.wrap.name()) + if md: + return '[{}](#{})'.format(self.__class__.__name__, self.__class__.__name__.lower()) return self.__class__.__name__ def check_wrap(self, value, path): @@ -98,7 +103,9 @@ def __init__(self, cls): def original_type(self): return self.cls - def name(self): + def name(self, md=False): + if md: + return '[{}](#{})'.format(self.cls.__name__, self.cls.__name__.lower()) return self.cls.__name__ def do_check(self, value, path): @@ -143,12 +150,14 @@ class Enum(KubeType): def __init__(self, *args): self.enums = args - def name(self): + def name(self, md=False): def fake_repr(x): ret = repr(x) if ret.startswith("u'"): return ret[1:] return ret + if md: + return '[{}](#{})({})'.format(self.__class__.__name__, self.__class__.__name__.lower(), ', '.join(map(fake_repr, self.enums))) return '{}({})'.format(self.__class__.__name__, ', '.join(map(fake_repr, self.enums))) def do_check(self, value, path): @@ -443,7 +452,9 @@ def __init__(self, *types): assert len(types) > 1 self.types = list(map(self.__class__.construct_arg, types)) - def name(self): + def name(self, md=False): + if md: + return '[{}](#{})<{}>'.format(self.__class__.__name__, self.__class__.__name__.lower, ', '.join(map(lambda x: x.name(md=True), self.types))) return self.__class__.__name__ + '<' + ', '.join(map(lambda x: x.name(), self.types)) + '>' def original_type(self): @@ -507,7 +518,9 @@ def __init__(self, key, value): self.key = self.__class__.construct_arg(key) self.value = self.__class__.construct_arg(value) - def name(self): + def name(self, md=False): + if md: + return '[{}](#{})<{}, {}>'.format(self.__class__.__name__, self.__class__.__name__.lower(), self.key.name(md=True), self.value.name(md=True)) return '{}<{}, {}>'.format(self.__class__.__name__, self.key.name(), self.value.name()) def original_type(self): From 083313c26e4720dbcd78f578ba0db5542d2c77a4 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 00:34:34 +0200 Subject: [PATCH 25/40] Removed buggy substitution --- docs/rubiks.class.md | 146 +++++++++++++++++++++---------------------- lib/kube_help.py | 2 +- 2 files changed, 74 insertions(+), 74 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 7faaec2..af31b7c 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -293,7 +293,7 @@ name | [Identifier](#identifier) | True | - | - aws-load-balancer-backend-protocol | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - aws-load-balancer-ssl-cert | [Nullable](#nullable)<[ARN](#arn)> | False | - | - externalTrafficPolicy | [Nullable](#nullable)<[Enum](#enum)('Cluster', 'Local')> | False | - | - -ports | [NonEmpty](#nonempty)<[List](#list)<[[ServicePort](#serviceport)](#serviceport)>> | False | <unknown transformation> | - +ports | [NonEmpty](#nonempty)<[List](#list)<[ServicePort](#serviceport)>> | False | <unknown transformation> | - selector | [NonEmpty](#nonempty)<[Map](#map)<[String](#string), [String](#string)>> | False | <unknown transformation> | - sessionAffinity | [Nullable](#nullable)<[Enum](#enum)('ClientIP', 'None')> | False | - | - ## BaseSelector @@ -319,7 +319,7 @@ Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - clusterIP | [Nullable](#nullable)<[IPv4](#ipv4)> | False | - | - -ports | [NonEmpty](#nonempty)<[List](#list)<[[ServicePort](#serviceport)](#serviceport)>> | False | <unknown transformation> | - +ports | [NonEmpty](#nonempty)<[List](#list)<[ServicePort](#serviceport)>> | False | <unknown transformation> | - selector | [NonEmpty](#nonempty)<[Map](#map)<[String](#string), [String](#string)>> | False | <unknown transformation> | - sessionAffinity | [Nullable](#nullable)<[Enum](#enum)('ClientIP', 'None')> | False | - | - ## ClusterRole @@ -335,7 +335,7 @@ labels | [Map](#map)<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -rules | [NonEmpty](#nonempty)<[List](#list)<[[PolicyRule](#policyrule)](#policyrule)>> | False | - | - +rules | [NonEmpty](#nonempty)<[List](#list)<[PolicyRule](#policyrule)>> | False | - | - ## ClusterRoleBinding ### Parents: - [RoleBindingBase](#rolebindingbase) @@ -350,8 +350,8 @@ labels | [Map](#map)<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -roleRef | [[RoleRef](#roleref)](#roleref) | False | <unknown transformation> | - -subjects | [NonEmpty](#nonempty)<[List](#list)<[[RoleSubject](#rolesubject)](#rolesubject)>> | False | <unknown transformation> | - +roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - +subjects | [NonEmpty](#nonempty)<[List](#list)<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## ConfigMap ### Metadata Name | Format @@ -530,8 +530,8 @@ memory | [Nullable](#nullable)<[Memory](#memory)> | False | - | - Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -limits | [[ContainerResourceEachSpec](#containerresourceeachspec)](#containerresourceeachspec) | False | - | - -requests | [[ContainerResourceEachSpec](#containerresourceeachspec)](#containerresourceeachspec) | False | - | - +limits | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - +requests | [ContainerResourceEachSpec](#containerresourceeachspec) | False | - | - ## ContainerSpec ### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) @@ -544,18 +544,18 @@ Name | Type | Identifier | Type Transformation | Aliases name | [Identifier](#identifier) | True | - | - args | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - command | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - -env | [Nullable](#nullable)<[List](#list)<[[ContainerEnvBaseSpec](#containerenvbasespec)](#containerenvbasespec)>> | False | <unknown transformation> | - +env | [Nullable](#nullable)<[List](#list)<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - image | [NonEmpty](#nonempty)<[String](#string)> | False | - | - imagePullPolicy | [Nullable](#nullable)<[Enum](#enum)('Always', 'IfNotPresent')> | False | - | - kind | [Nullable](#nullable)<[Enum](#enum)('DockerImage')> | False | - | - -lifecycle | [Nullable](#nullable)<[[LifeCycle](#lifecycle)](#lifecycle)> | False | - | - -livenessProbe | [Nullable](#nullable)<[[ContainerProbeBaseSpec](#containerprobebasespec)](#containerprobebasespec)> | False | - | - -ports | [Nullable](#nullable)<[List](#list)<[[ContainerPort](#containerport)](#containerport)>> | False | <unknown transformation> | - -readinessProbe | [Nullable](#nullable)<[[ContainerProbeBaseSpec](#containerprobebasespec)](#containerprobebasespec)> | False | - | - -resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - -securityContext | [Nullable](#nullable)<[[SecurityContext](#securitycontext)](#securitycontext)> | False | - | - +lifecycle | [Nullable](#nullable)<[LifeCycle](#lifecycle)> | False | - | - +livenessProbe | [Nullable](#nullable)<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - +ports | [Nullable](#nullable)<[List](#list)<[ContainerPort](#containerport)>> | False | <unknown transformation> | - +readinessProbe | [Nullable](#nullable)<[ContainerProbeBaseSpec](#containerprobebasespec)> | False | - | - +resources | [Nullable](#nullable)<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +securityContext | [Nullable](#nullable)<[SecurityContext](#securitycontext)> | False | - | - terminationMessagePath | [Nullable](#nullable)<[NonEmpty](#nonempty)<[Path](#path)>> | False | - | - -volumeMounts | [Nullable](#nullable)<[List](#list)<[[ContainerVolumeMountSpec](#containervolumemountspec)](#containervolumemountspec)>> | False | <unknown transformation> | - +volumeMounts | [Nullable](#nullable)<[List](#list)<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | <unknown transformation> | - ## ContainerVolumeMountSpec ### Parent types: - [ContainerSpec](#containerspec) @@ -581,7 +581,7 @@ Name | Type | Identifier | Type Transformation | Aliases activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - annotations | [Map](#map)<[String](#string), [String](#string)> | False | - | - labels | [Map](#map)<[String](#string), [String](#string)> | False | - | - -resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - +resources | [Nullable](#nullable)<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## DCConfigChangeTrigger ### Parents: - [DCTrigger](#dctrigger) @@ -599,7 +599,7 @@ resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresource Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- command | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - -environment | [Nullable](#nullable)<[List](#list)<[[ContainerEnvBaseSpec](#containerenvbasespec)](#containerenvbasespec)>> | False | <unknown transformation> | - +environment | [Nullable](#nullable)<[List](#list)<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - image | [NonEmpty](#nonempty)<[String](#string)> | False | - | - ## DCCustomStrategy ### Parents: @@ -612,9 +612,9 @@ Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - annotations | [Map](#map)<[String](#string), [String](#string)> | False | - | - -customParams | [[DCCustomParams](#dccustomparams)](#dccustomparams) | False | - | - +customParams | [DCCustomParams](#dccustomparams) | False | - | - labels | [Map](#map)<[String](#string), [String](#string)> | False | - | - -resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - +resources | [Nullable](#nullable)<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## DCImageChangeTrigger ### Parents: - [DCTrigger](#dctrigger) @@ -628,9 +628,9 @@ resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresource Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -execNewPod | [Nullable](#nullable)<[[DCLifecycleNewPod](#dclifecyclenewpod)](#dclifecyclenewpod)> | False | - | - +execNewPod | [Nullable](#nullable)<[DCLifecycleNewPod](#dclifecyclenewpod)> | False | - | - failurePolicy | [Enum](#enum)('Abort', 'Retry', 'Ignore') | False | - | - -tagImages | [Nullable](#nullable)<[[DCTagImages](#dctagimages)](#dctagimages)> | False | - | - +tagImages | [Nullable](#nullable)<[DCTagImages](#dctagimages)> | False | - | - ## DCLifecycleNewPod ### Parents: - [EnvironmentPreProcessMixin](#environmentpreprocessmixin) @@ -642,8 +642,8 @@ Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- command | [NonEmpty](#nonempty)<[List](#list)<[String](#string)>> | False | - | - containerName | [Identifier](#identifier) | False | - | - -env | [Nullable](#nullable)<[List](#list)<[[ContainerEnvBaseSpec](#containerenvbasespec)](#containerenvbasespec)>> | False | <unknown transformation> | - -volumeMounts | [Nullable](#nullable)<[List](#list)<[[ContainerVolumeMountSpec](#containervolumemountspec)](#containervolumemountspec)>> | False | - | - +env | [Nullable](#nullable)<[List](#list)<[ContainerEnvBaseSpec](#containerenvbasespec)>> | False | <unknown transformation> | - +volumeMounts | [Nullable](#nullable)<[List](#list)<[ContainerVolumeMountSpec](#containervolumemountspec)>> | False | - | - volumes | [Nullable](#nullable)<[List](#list)<[Identifier](#identifier)>> | False | - | - ## DCRecreateParams ### Parent types: @@ -652,9 +652,9 @@ volumes | [Nullable](#nullable)<[List](#list)<[Identifier](#identifier)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -mid | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - -post | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - -pre | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - +mid | [Nullable](#nullable)<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +post | [Nullable](#nullable)<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +pre | [Nullable](#nullable)<[DCLifecycleHook](#dclifecyclehook)> | False | - | - timeoutSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - ## DCRecreateStrategy ### Parents: @@ -667,10 +667,10 @@ Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - annotations | [Map](#map)<[String](#string), [String](#string)> | False | - | - -customParams | [Nullable](#nullable)<[[DCCustomParams](#dccustomparams)](#dccustomparams)> | False | - | - +customParams | [Nullable](#nullable)<[DCCustomParams](#dccustomparams)> | False | - | - labels | [Map](#map)<[String](#string), [String](#string)> | False | - | - -recreateParams | [Nullable](#nullable)<[[DCRecreateParams](#dcrecreateparams)](#dcrecreateparams)> | False | - | - -resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - +recreateParams | [Nullable](#nullable)<[DCRecreateParams](#dcrecreateparams)> | False | - | - +resources | [Nullable](#nullable)<[ContainerResourceSpec](#containerresourcespec)> | False | - | - ## DCRollingParams ### Parent types: - [DCRollingStrategy](#dcrollingstrategy) @@ -681,8 +681,8 @@ Name | Type | Identifier | Type Transformation | Aliases intervalSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - maxSurge | [SurgeSpec](#surgespec) | False | - | - maxUnavailable | [SurgeSpec](#surgespec) | False | - | - -post | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - -pre | [Nullable](#nullable)<[[DCLifecycleHook](#dclifecyclehook)](#dclifecyclehook)> | False | - | - +post | [Nullable](#nullable)<[DCLifecycleHook](#dclifecyclehook)> | False | - | - +pre | [Nullable](#nullable)<[DCLifecycleHook](#dclifecyclehook)> | False | - | - timeoutSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - updatePeriodSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - ## DCRollingStrategy @@ -696,10 +696,10 @@ Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - annotations | [Map](#map)<[String](#string), [String](#string)> | False | - | - -customParams | [Nullable](#nullable)<[[DCCustomParams](#dccustomparams)](#dccustomparams)> | False | - | - +customParams | [Nullable](#nullable)<[DCCustomParams](#dccustomparams)> | False | - | - labels | [Map](#map)<[String](#string), [String](#string)> | False | - | - -resources | [Nullable](#nullable)<[[ContainerResourceSpec](#containerresourcespec)](#containerresourcespec)> | False | - | - -rollingParams | [Nullable](#nullable)<[[DCRollingParams](#dcrollingparams)](#dcrollingparams)> | False | - | - +resources | [Nullable](#nullable)<[ContainerResourceSpec](#containerresourcespec)> | False | - | - +rollingParams | [Nullable](#nullable)<[DCRollingParams](#dcrollingparams)> | False | - | - ## DCTagImages ### Parent types: - [DCLifecycleHook](#dclifecyclehook) @@ -734,8 +734,8 @@ labels | [Map](#map)<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - -selector | [Nullable](#nullable)<[[BaseSelector](#baseselector)](#baseselector)> | False | <unknown transformation> | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +selector | [Nullable](#nullable)<[BaseSelector](#baseselector)> | False | <unknown transformation> | - ## [Deployment](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) @@ -756,12 +756,12 @@ Name | Type | Identifier | Type Transformation | Aliases name | [Identifier](#identifier) | True | - | - minReadySeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - paused | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - -pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - progressDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - replicas | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - revisionHistoryLimit | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - -selector | [Nullable](#nullable)<[[BaseSelector](#baseselector)](#baseselector)> | False | - | - -strategy | [Nullable](#nullable)<[[DplBaseUpdateStrategy](#dplbaseupdatestrategy)](#dplbaseupdatestrategy)> | False | - | - +selector | [Nullable](#nullable)<[BaseSelector](#baseselector)> | False | - | - +strategy | [Nullable](#nullable)<[DplBaseUpdateStrategy](#dplbaseupdatestrategy)> | False | - | - ## DeploymentConfig ### Metadata Name | Format @@ -775,13 +775,13 @@ Name | Type | Identifier | Type Transformation | Aliases name | [Identifier](#identifier) | True | - | - minReadySeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - paused | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - -pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - replicas | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - revisionHistoryLimit | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - selector | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - -strategy | [[DCBaseUpdateStrategy](#dcbaseupdatestrategy)](#dcbaseupdatestrategy) | False | - | - +strategy | [DCBaseUpdateStrategy](#dcbaseupdatestrategy) | False | - | - test | [Boolean](#boolean) | False | - | - -triggers | [List](#list)<[[DCTrigger](#dctrigger)](#dctrigger)> | False | - | - +triggers | [List](#list)<[DCTrigger](#dctrigger)> | False | - | - ## DockerCredentials ### Parents: - [Secret](#secret) @@ -847,8 +847,8 @@ activeDeadlineSeconds | [Nullable](#nullable)<[Positive](#positive)<[Integ completions | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - manualSelector | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - parallelism | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - -pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - -selector | [Nullable](#nullable)<[[BaseSelector](#baseselector)](#baseselector)> | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - +selector | [Nullable](#nullable)<[BaseSelector](#baseselector)> | False | - | - ## LifeCycle ### Parent types: - [ContainerSpec](#containerspec) @@ -856,8 +856,8 @@ selector | [Nullable](#nullable)<[[BaseSelector](#baseselector)](#baseselecto Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -postStart | [Nullable](#nullable)<[[LifeCycleProbe](#lifecycleprobe)](#lifecycleprobe)> | False | - | - -preStop | [Nullable](#nullable)<[[LifeCycleProbe](#lifecycleprobe)](#lifecycleprobe)> | False | - | - +postStart | [Nullable](#nullable)<[LifeCycleProbe](#lifecycleprobe)> | False | - | - +preStop | [Nullable](#nullable)<[LifeCycleProbe](#lifecycleprobe)> | False | - | - ## LifeCycleExec ### Parents: - [LifeCycleProbe](#lifecycleprobe) @@ -908,7 +908,7 @@ values | [Nullable](#nullable)<[List](#list)<[String](#string)>> | F Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -matchExpressions | [NonEmpty](#nonempty)<[List](#list)<[[MatchExpression](#matchexpression)](#matchexpression)>> | False | - | - +matchExpressions | [NonEmpty](#nonempty)<[List](#list)<[MatchExpression](#matchexpression)>> | False | - | - ## MatchLabelsSelector ### Parents: - [BaseSelector](#baseselector) @@ -947,9 +947,9 @@ Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - accessModes | [List](#list)<[Enum](#enum)('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - -awsElasticBlockStore | [Nullable](#nullable)<[[AWSElasticBlockStore](#awselasticblockstore)](#awselasticblockstore)> | False | - | - +awsElasticBlockStore | [Nullable](#nullable)<[AWSElasticBlockStore](#awselasticblockstore)> | False | - | - capacity | [Memory](#memory) | False | - | - -claimRef | [Nullable](#nullable)<[[PersistentVolumeRef](#persistentvolumeref)](#persistentvolumeref)> | False | - | - +claimRef | [Nullable](#nullable)<[PersistentVolumeRef](#persistentvolumeref)> | False | - | - persistentVolumeReclaimPolicy | [Nullable](#nullable)<[Enum](#enum)('Retain', 'Recycle', 'Delete')> | False | - | - ## PersistentVolumeClaim ### Metadata @@ -964,7 +964,7 @@ Name | Type | Identifier | Type Transformation | Aliases name | [Identifier](#identifier) | True | - | - accessModes | [List](#list)<[Enum](#enum)('ReadWriteOnce', 'ReadOnlyMany', 'ReadWriteMany')> | False | - | - request | [Memory](#memory) | False | - | - -selector | [Nullable](#nullable)<[[BaseSelector](#baseselector)](#baseselector)> | False | - | - +selector | [Nullable](#nullable)<[BaseSelector](#baseselector)> | False | - | - volumeName | [Nullable](#nullable)<[Identifier](#identifier)> | False | <unknown transformation> | - ## PersistentVolumeRef ### Parent types: @@ -1001,19 +1001,19 @@ labels | [Map](#map)<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -containers | [NonEmpty](#nonempty)<[List](#list)<[[ContainerSpec](#containerspec)](#containerspec)>> | False | - | - +containers | [NonEmpty](#nonempty)<[List](#list)<[ContainerSpec](#containerspec)>> | False | - | - dnsPolicy | [Nullable](#nullable)<[Enum](#enum)('ClusterFirst')> | False | - | - hostIPC | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - hostNetwork | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - hostPID | [Nullable](#nullable)<[Boolean](#boolean)> | False | - | - -imagePullSecrets | [Nullable](#nullable)<[List](#list)<[[PodImagePullSecret](#podimagepullsecret)](#podimagepullsecret)>> | False | <unknown transformation> | - +imagePullSecrets | [Nullable](#nullable)<[List](#list)<[PodImagePullSecret](#podimagepullsecret)>> | False | <unknown transformation> | - name | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - nodeSelector | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - restartPolicy | [Nullable](#nullable)<[Enum](#enum)('Always', 'OnFailure', 'Never')> | False | - | - -securityContext | [Nullable](#nullable)<[[SecurityContext](#securitycontext)](#securitycontext)> | False | - | - +securityContext | [Nullable](#nullable)<[SecurityContext](#securitycontext)> | False | - | - serviceAccountName | [Nullable](#nullable)<[Identifier](#identifier)> | False | <unknown transformation> | [serviceAccount](#serviceaccount) terminationGracePeriodSeconds | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - -volumes | [Nullable](#nullable)<[List](#list)<[[PodVolumeBaseSpec](#podvolumebasespec)](#podvolumebasespec)>> | False | - | - +volumes | [Nullable](#nullable)<[List](#list)<[PodVolumeBaseSpec](#podvolumebasespec)>> | False | - | - ## PodVolumeBaseSpec ### Children: - [PodVolumeHostSpec](#podvolumehostspec) @@ -1114,7 +1114,7 @@ labels | [Map](#map)<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [ColonIdentifier](#colonidentifier) | True | - | - -roleBindings | [List](#list)<[[PolicyBindingRoleBinding](#policybindingrolebinding)](#policybindingrolebinding)> | False | <unknown transformation> | - +roleBindings | [List](#list)<[PolicyBindingRoleBinding](#policybindingrolebinding)> | False | <unknown transformation> | - ## PolicyBindingRoleBinding ### Parents: - [RoleBindingXF](#rolebindingxf) @@ -1127,8 +1127,8 @@ Name | Type | Identifier | Type Transformation | Aliases metadata | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - name | [SystemIdentifier](#systemidentifier) | False | - | - ns | [Identifier](#identifier) | False | - | - -roleRef | [[RoleRef](#roleref)](#roleref) | False | <unknown transformation> | - -subjects | [NonEmpty](#nonempty)<[List](#list)<[[RoleSubject](#rolesubject)](#rolesubject)>> | False | <unknown transformation> | - +roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - +subjects | [NonEmpty](#nonempty)<[List](#list)<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## PolicyRule ### Parent types: - [ClusterRole](#clusterrole) @@ -1169,7 +1169,7 @@ Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - minReadySeconds | [Nullable](#nullable)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>> | False | - | - -pod_template | [[PodTemplateSpec](#podtemplatespec)](#podtemplatespec) | False | - | - +pod_template | [PodTemplateSpec](#podtemplatespec) | False | - | - replicas | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - selector | [Nullable](#nullable)<[Map](#map)<[String](#string), [String](#string)>> | False | - | - ## Role @@ -1185,7 +1185,7 @@ labels | [Map](#map)<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -rules | [NonEmpty](#nonempty)<[List](#list)<[[PolicyRule](#policyrule)](#policyrule)>> | False | - | - +rules | [NonEmpty](#nonempty)<[List](#list)<[PolicyRule](#policyrule)>> | False | - | - ## RoleBinding ### Parents: - [RoleBindingBase](#rolebindingbase) @@ -1200,8 +1200,8 @@ labels | [Map](#map)<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [SystemIdentifier](#systemidentifier) | True | - | - -roleRef | [[RoleRef](#roleref)](#roleref) | False | <unknown transformation> | - -subjects | [NonEmpty](#nonempty)<[List](#list)<[[RoleSubject](#rolesubject)](#rolesubject)>> | False | <unknown transformation> | - +roleRef | [RoleRef](#roleref) | False | <unknown transformation> | - +subjects | [NonEmpty](#nonempty)<[List](#list)<[RoleSubject](#rolesubject)>> | False | <unknown transformation> | - ## RoleRef ### Parent types: - [ClusterRoleBinding](#clusterrolebinding) @@ -1239,9 +1239,9 @@ Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - host | [Domain](#domain) | False | - | - -port | [[RouteDestPort](#routedestport)](#routedestport) | False | - | - -tls | [Nullable](#nullable)<[[RouteTLS](#routetls)](#routetls)> | False | - | - -to | [NonEmpty](#nonempty)<[List](#list)<[[RouteDest](#routedest)](#routedest)>> | False | - | - +port | [RouteDestPort](#routedestport) | False | - | - +tls | [Nullable](#nullable)<[RouteTLS](#routetls)> | False | - | - +to | [NonEmpty](#nonempty)<[List](#list)<[RouteDest](#routedest)>> | False | - | - wildcardPolicy | [Enum](#enum)('Subdomain', 'None') | False | - | - ## RouteDest ### Children: @@ -1319,7 +1319,7 @@ min | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- -ranges | [Nullable](#nullable)<[List](#list)<[[SCCGroupRange](#sccgrouprange)](#sccgrouprange)>> | False | - | - +ranges | [Nullable](#nullable)<[List](#list)<[SCCGroupRange](#sccgrouprange)>> | False | - | - type | [Nullable](#nullable)<[Enum](#enum)('MustRunAs', 'RunAsAny')> | False | - | - ## SCCRunAsUser ### Parent types: @@ -1392,15 +1392,15 @@ allowHostPorts | [Boolean](#boolean) | False | - | - allowPrivilegedContainer | [Boolean](#boolean) | False | - | - allowedCapabilities | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - defaultAddCapabilities | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - -fsGroup | [Nullable](#nullable)<[[SCCGroups](#sccgroups)](#sccgroups)> | False | - | - +fsGroup | [Nullable](#nullable)<[SCCGroups](#sccgroups)> | False | - | - groups | [List](#list)<[SystemIdentifier](#systemidentifier)> | False | - | - priority | [Nullable](#nullable)<[Positive](#positive)<[Integer](#integer)>> | False | - | - readOnlyRootFilesystem | [Boolean](#boolean) | False | - | - requiredDropCapabilities | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - -runAsUser | [Nullable](#nullable)<[[SCCRunAsUser](#sccrunasuser)](#sccrunasuser)> | False | - | - -seLinuxContext | [Nullable](#nullable)<[[SCCSELinux](#sccselinux)](#sccselinux)> | False | - | - +runAsUser | [Nullable](#nullable)<[SCCRunAsUser](#sccrunasuser)> | False | - | - +seLinuxContext | [Nullable](#nullable)<[SCCSELinux](#sccselinux)> | False | - | - seccompProfiles | [Nullable](#nullable)<[List](#list)<[String](#string)>> | False | - | - -supplementalGroups | [Nullable](#nullable)<[[SCCGroups](#sccgroups)](#sccgroups)> | False | - | - +supplementalGroups | [Nullable](#nullable)<[SCCGroups](#sccgroups)> | False | - | - users | [List](#list)<[SystemIdentifier](#systemidentifier)> | False | - | - volumes | [List](#list)<[Enum](#enum)('configMap', 'downwardAPI', 'emptyDir', 'hostPath', 'nfs', 'persistentVolumeClaim', 'secret', '*')> | False | - | - ## Service @@ -1417,7 +1417,7 @@ labels | [Map](#map)<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -ports | [NonEmpty](#nonempty)<[List](#list)<[[ServicePort](#serviceport)](#serviceport)>> | False | <unknown transformation> | - +ports | [NonEmpty](#nonempty)<[List](#list)<[ServicePort](#serviceport)>> | False | <unknown transformation> | - selector | [NonEmpty](#nonempty)<[Map](#map)<[String](#string), [String](#string)>> | False | <unknown transformation> | - sessionAffinity | [Nullable](#nullable)<[Enum](#enum)('ClientIP', 'None')> | False | - | - ## ServiceAccount @@ -1431,8 +1431,8 @@ labels | [Map](#map)<[String](#string), [String](#string)> Name | Type | Identifier | Type Transformation | Aliases ---- | ---- | ---------- | ------------------- | ------- name | [Identifier](#identifier) | True | - | - -imagePullSecrets | [Nullable](#nullable)<[List](#list)<[[SAImgPullSecretSubject](#saimgpullsecretsubject)](#saimgpullsecretsubject)>> | False | <unknown transformation> | - -secrets | [Nullable](#nullable)<[List](#list)<[[SASecretSubject](#sasecretsubject)](#sasecretsubject)>> | False | <unknown transformation> | - +imagePullSecrets | [Nullable](#nullable)<[List](#list)<[SAImgPullSecretSubject](#saimgpullsecretsubject)>> | False | <unknown transformation> | - +secrets | [Nullable](#nullable)<[List](#list)<[SASecretSubject](#sasecretsubject)>> | False | <unknown transformation> | - ## ServicePort ### Parent types: - [AWSLoadBalancerService](#awsloadbalancerservice) @@ -1445,7 +1445,7 @@ Name | Type | Identifier | Type Transformation | Aliases name | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - port | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - protocol | [Enum](#enum)('TCP', 'UDP') | False | - | - -targetPort | [OneOf](#<built-in method lower of str object at 0x10a459bd0>)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>, [Identifier](#identifier)> | False | - | - +targetPort | [OneOf](#<built-in method lower of str object at 0x109273b10>)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>, [Identifier](#identifier)> | False | - | - ## StorageClass ### Metadata Name | Format diff --git a/lib/kube_help.py b/lib/kube_help.py index a56d4b5..2ff7abb 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -191,7 +191,7 @@ def render_markdown(self, links=[]): elif isinstance(original_type, dict): original_type = original_type['value'] classname = original_type.__name__ - display_type = display_type.replace(classname, self._get_markdown_link(classname)) + # display_type = display_type.replace(classname, self._get_markdown_link(classname)) # display_type = self._decorate_obj_links(display=display_type, links=links) From 35abd38d130a9322a9ea7ca77f48b895f935972d Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 00:39:08 +0200 Subject: [PATCH 26/40] Fix on OneOf object representation --- docs/rubiks.class.md | 2 +- lib/kube_help.py | 2 +- lib/kube_types.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index af31b7c..2b343a8 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -1445,7 +1445,7 @@ Name | Type | Identifier | Type Transformation | Aliases name | [Nullable](#nullable)<[Identifier](#identifier)> | False | - | - port | [Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>> | False | - | - protocol | [Enum](#enum)('TCP', 'UDP') | False | - | - -targetPort | [OneOf](#<built-in method lower of str object at 0x109273b10>)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>, [Identifier](#identifier)> | False | - | - +targetPort | [OneOf](#oneof)<[Positive](#positive)<[NonZero](#nonzero)<[Integer](#integer)>>, [Identifier](#identifier)> | False | - | - ## StorageClass ### Metadata Name | Format diff --git a/lib/kube_help.py b/lib/kube_help.py index 2ff7abb..cc9189f 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -178,7 +178,7 @@ def render_markdown(self, links=[]): # Prepare Type transformation and remove special character that could ruin visualization in markdown xf_data = self.class_xf_detail[p] if p in self.class_xf_detail else '-' xf_data = xf_data.replace('<', '<').replace('>', '>') - xf_data = self._decorate_obj_links(display=xf_data, links=links) + # xf_data = self._decorate_obj_links(display=xf_data, links=links) is_mapped = ', '.join(self._get_markdown_link(self.class_mapping[p])) if p in self.class_mapping else '-' diff --git a/lib/kube_types.py b/lib/kube_types.py index af6680d..02e8a36 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -454,7 +454,7 @@ def __init__(self, *types): def name(self, md=False): if md: - return '[{}](#{})<{}>'.format(self.__class__.__name__, self.__class__.__name__.lower, ', '.join(map(lambda x: x.name(md=True), self.types))) + return '[{}](#{})<{}>'.format(self.__class__.__name__, self.__class__.__name__.lower(), ', '.join(map(lambda x: x.name(md=True), self.types))) return self.__class__.__name__ + '<' + ', '.join(map(lambda x: x.name(), self.types)) + '>' def original_type(self): From 286968eb1a564463c6bd0dd301d27b7bff9d2be6 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 01:10:55 +0200 Subject: [PATCH 27/40] Fixed discover for wrappers --- docs/rubiks.class.md | 33 +++++++++++++++++++++++++++++++++ lib/load_python.py | 16 +++++++++++----- 2 files changed, 44 insertions(+), 5 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 2b343a8..d6d8d2b 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -22,8 +22,13 @@ This document is automatically generated using the command `docgen` and describe - [IPv4](#ipv4) - [Identifier](#identifier) - [Integer](#integer) + - [List](#list) + - [NonEmpty](#nonempty) + - [NonZero](#nonzero) + - [Nullable](#nullable) - [Number](#number) - [Path](#path) + - [Positive](#positive) - [String](#string) - [SurgeSpec](#surgespec) - [SystemIdentifier](#systemidentifier) @@ -239,6 +244,28 @@ An integer is a whole number (not a fraction) that can be positive, negative, or Therefore, the numbers 10, 0, -25, and 5,148 are all integers. Unlike floating point numbers, integers cannot have decimal places. +## List + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## NonEmpty + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + +## NonZero + + +Represent any number that is not 0. +Will be accepted positive and negative of any kind. + + +## Nullable + +TODO: Description is still missing from the class docstring. +Stay tuned to have more hint about this variable. + ## Number @@ -250,6 +277,12 @@ An integer is a whole number (not a fraction) that can be positive, negative, fl TODO: Description is still missing from the class docstring. Stay tuned to have more hint about this variable. +## Positive + + +Define a number that needs to be positive (0 is included as positive) + + ## String TODO: Description is still missing from the class docstring. diff --git a/lib/load_python.py b/lib/load_python.py index a699865..5af302e 100644 --- a/lib/load_python.py +++ b/lib/load_python.py @@ -250,12 +250,18 @@ def get_kube_types(cls): cls._kube_type = {} for k in kube_types.__dict__: - if isinstance(kube_types.__dict__[k], type) and k not in ('KubeType'): + print('{} - {} - {}'.format(kube_types.__dict__[k], k, isinstance(kube_types.__dict__[k], type))) + if isinstance(kube_types.__dict__[k], type) and k not in ('KubeType', 'SurgeCheck'): try: - if isinstance(kube_objs.__dict__[k](), KubeType): - cls._kube_type[k] = kube_types.__dict__[k] - except: - pass + if hasattr(kube_types.__dict__[k], 'wrapper'): + if kube_types.__dict__[k].wrapper: + if isinstance(kube_types.__dict__[k](kube_types.String), kube_types.KubeType): + cls._kube_type[k] = kube_types.__dict__[k] + else: + if isinstance(kube_types.__dict__[k](), kube_types.KubeType): + cls._kube_type[k] = kube_types.__dict__[k] + except Exception as e: + print(e) return cls._kube_type From 968fbe28a09131d99616927df9a72342d0d3d94f Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 01:11:34 +0200 Subject: [PATCH 28/40] Removed debugs --- lib/load_python.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/lib/load_python.py b/lib/load_python.py index 5af302e..cb6492f 100644 --- a/lib/load_python.py +++ b/lib/load_python.py @@ -250,7 +250,6 @@ def get_kube_types(cls): cls._kube_type = {} for k in kube_types.__dict__: - print('{} - {} - {}'.format(kube_types.__dict__[k], k, isinstance(kube_types.__dict__[k], type))) if isinstance(kube_types.__dict__[k], type) and k not in ('KubeType', 'SurgeCheck'): try: if hasattr(kube_types.__dict__[k], 'wrapper'): @@ -260,8 +259,8 @@ def get_kube_types(cls): else: if isinstance(kube_types.__dict__[k](), kube_types.KubeType): cls._kube_type[k] = kube_types.__dict__[k] - except Exception as e: - print(e) + except: + pass return cls._kube_type From 93ed133efe169a702a73ec8e53fd0ab4b5fcfc8b Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 09:36:10 +0200 Subject: [PATCH 29/40] Removed unused variable --- lib/commands/docgen.py | 4 +--- lib/kube_help.py | 6 +----- 2 files changed, 2 insertions(+), 8 deletions(-) diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index 3dafabf..e4bf1fc 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -24,8 +24,6 @@ def run(self, args): objs = load_python.PythonBaseFile.get_kube_objs() types = load_python.PythonBaseFile.get_kube_types() formats = load_python.PythonBaseFile.get_kube_vartypes() - - additional_links = types.keys() + formats.keys() r = self.get_repository() @@ -54,7 +52,7 @@ def run(self, args): md += '\n# Objects\n\n' for oname in sorted(objs.keys()): header += ' - [{}](#{})\n'.format(oname, oname.lower()) - md += objs[oname].get_help().render_markdown(links=additional_links) + md += objs[oname].get_help().render_markdown() with open(os.path.join(r.basepath, 'docs/rubiks.class.md'), 'w') as f: f.write(header.encode('utf-8')) diff --git a/lib/kube_help.py b/lib/kube_help.py index cc9189f..0432a57 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -124,7 +124,7 @@ def _decorate_obj_links(self, display, links): return display - def render_markdown(self, links=[]): + def render_markdown(self): # Title generation based on link if self.class_doc_link is not None: txt = '## [{}]({})\n'.format(self.class_name, self.class_doc_link) @@ -178,7 +178,6 @@ def render_markdown(self, links=[]): # Prepare Type transformation and remove special character that could ruin visualization in markdown xf_data = self.class_xf_detail[p] if p in self.class_xf_detail else '-' xf_data = xf_data.replace('<', '<').replace('>', '>') - # xf_data = self._decorate_obj_links(display=xf_data, links=links) is_mapped = ', '.join(self._get_markdown_link(self.class_mapping[p])) if p in self.class_mapping else '-' @@ -190,9 +189,6 @@ def render_markdown(self, links=[]): original_type = original_type[0] elif isinstance(original_type, dict): original_type = original_type['value'] - classname = original_type.__name__ - # display_type = display_type.replace(classname, self._get_markdown_link(classname)) - # display_type = self._decorate_obj_links(display=display_type, links=links) txt += '{} | {} | False | {} | {} \n'.format(p, display_type, xf_data, is_mapped) From b7daccf579b450109465d2fd69659d61cb68208b Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 09:48:55 +0200 Subject: [PATCH 30/40] Test for README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 335a54c..a696c14 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -![Rubiks Logo](docs/logos/rubiks-logo-horizontal.png) +

+ +

# Rubiks - a kubernetes yaml file manager @@ -30,3 +32,4 @@ See also `rubiks help` for more information on how to use it - [Rubiks repositories and the .rubiks file](docs/Rubiks%20repositories%20and%20the%20.rubiks%20file.md) - [Examples](https://github.com/olx-global/rubiks-examples) - [Logo Variants](docs/logos/logos.md) +- [Classes Definitions](docs/rubiks.class.md) From 9c7cb2a6dcaf183c13ed26c5467f960e5a192d4b Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 09:51:08 +0200 Subject: [PATCH 31/40] Added logo to the class --- docs/rubiks.class.md | 2 +- lib/commands/docgen.py | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index d6d8d2b..ddfa9c1 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -1,4 +1,4 @@ -# Rubiks Object Index +

# Rubiks Object Index This document is automatically generated using the command `docgen` and describe all the object and types that can be used inside Rubiks to configure your cluster diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index e4bf1fc..3c62c3c 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -30,7 +30,8 @@ def run(self, args): doc = '\n'.join([line.strip() for line in self._description.split('\n')]) md = '' - header = '# Rubiks Object Index\n{}\n\n'.format(doc) + header = '

' + header += '# Rubiks Object Index\n{}\n\n'.format(doc) header += '# Table of contents\n\n' header += '- [Formats](#formats)\n' From efb4966642c7e10bc9122858ebe3dccb01e837df Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 09:51:39 +0200 Subject: [PATCH 32/40] Fix on the title --- docs/rubiks.class.md | 3 ++- lib/commands/docgen.py | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index ddfa9c1..c2c0c81 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -1,4 +1,5 @@ -

# Rubiks Object Index +

+# Rubiks Object Index This document is automatically generated using the command `docgen` and describe all the object and types that can be used inside Rubiks to configure your cluster diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index 3c62c3c..35f9bbd 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -30,7 +30,7 @@ def run(self, args): doc = '\n'.join([line.strip() for line in self._description.split('\n')]) md = '' - header = '

' + header = '

\n' header += '# Rubiks Object Index\n{}\n\n'.format(doc) header += '# Table of contents\n\n' From 70bf6bd9b652bbbf6f9e80afd535d7b8c5279e32 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 09:52:11 +0200 Subject: [PATCH 33/40] More fix --- docs/rubiks.class.md | 1 + lib/commands/docgen.py | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index c2c0c81..d576fca 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -1,4 +1,5 @@

+ # Rubiks Object Index This document is automatically generated using the command `docgen` and describe all the object and types that can be used inside Rubiks to configure your cluster diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index 35f9bbd..768b8c5 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -30,7 +30,7 @@ def run(self, args): doc = '\n'.join([line.strip() for line in self._description.split('\n')]) md = '' - header = '

\n' + header = '

\n\n' header += '# Rubiks Object Index\n{}\n\n'.format(doc) header += '# Table of contents\n\n' From 085bfcc6453b95ba317a6f27668d608a9a0e39ab Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 10:18:57 +0200 Subject: [PATCH 34/40] Moved top level docs inside docstring --- docs/rubiks.class.md | 2 ++ lib/commands/docgen.py | 8 ++++---- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index d576fca..232b115 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -4,6 +4,8 @@ This document is automatically generated using the command `docgen` and describe all the object and types that can be used inside Rubiks to configure your cluster +It is possible to generate this documentation locally running inside your rubiks repo `rubiks docgen`. + # Table of contents diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index 768b8c5..fa1dc04 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -11,10 +11,10 @@ import os class Command_docgen(Command, CommandRepositoryBase): - """Generate a markdown file with basic description for all object inside rubiks""" - - _description = """ + """ This document is automatically generated using the command `docgen` and describe all the object and types that can be used inside Rubiks to configure your cluster + + It is possible to generate this documentation locally running inside your rubiks repo `rubiks docgen`. """ def populate_args(self, parser): @@ -27,7 +27,7 @@ def run(self, args): r = self.get_repository() - doc = '\n'.join([line.strip() for line in self._description.split('\n')]) + doc = '\n'.join([line.strip() for line in self.__class__.__doc__.split('\n')]) md = '' header = '

\n\n' From 59b759afd7f4f80e4dca50a0b906d92107a109bc Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 11:11:41 +0200 Subject: [PATCH 35/40] Added more details --- docs/rubiks.class.md | 103 +++++++++++++++++++++++++++++++++---------- lib/kube_types.py | 96 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 175 insertions(+), 24 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 232b115..8964aca 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -24,6 +24,7 @@ It is possible to generate this documentation locally running inside your rubiks - [Enum](#enum) - [IP](#ip) - [IPv4](#ipv4) + - [IPv6](#ipv6) - [Identifier](#identifier) - [Integer](#integer) - [List](#list) @@ -203,18 +204,35 @@ Boolean expressions use the operators AND, OR, XOR, and NOT to compare values an ## CaseIdentifier -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +An Identifier should be shorten thsn 253 chars and alphanum or . or - + ## ColonIdentifier -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +An Identifier should be shorten than 253 chars and lc alphanum or . or - or : + ## Domain -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +The definitive descriptions of the rules for forming domain names appear in [RFC 1035](https://tools.ietf.org/html/rfc1035), [RFC 1123](https://tools.ietf.org/html/rfc1123), and [RFC 2181](https://tools.ietf.org/html/rfc2181). A domain name consists of one or more parts, technically called labels, that are conventionally concatenated, and delimited by dots, such as `example.com`. + +The right-most label conveys the top-level domain; for example, the domain name `www.example.com` belongs to the top-level domain `com`. + +The hierarchy of domains descends from right to left; each label to the left specifies a subdivision, or subdomain of the domain to the right. For example, the label example specifies a subdomain of the com domain, and www is a subdomain of example.com. +This tree of subdivisions may have up to 127 levels. + +A label may contain zero to 63 characters. The null label, of length zero, is reserved for the root zone. +The full domain name may not exceed the length of 253 characters in its textual representation.In the internal binary representation of the DNS the maximum length requires 255 octets of storage, as it also stores the length of the name. + +Although no technical limitation exists to use any character in domain name labels which are representable by an octet, hostnames use a preferred format and character set. +The characters allowed in labels are a subset of the ASCII character set, consisting of characters a through z, A through Z, digits 0 through 9, and hyphen. +This rule is known as the LDH rule (letters, digits, hyphen). +Domain names are interpreted in case-independent manner. +Labels may not start or end with a hyphen. An additional rule requires that top-level domain names should not be all-numeric.[20] + ## Enum @@ -228,18 +246,43 @@ Enum, short for "enumerated," is a data type that consists of predefined values. ## IP -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +An Internet Protocol address (IP address) is a numerical label assigned to each device connected to a computer network that uses the Internet Protocol for communication. + +An IP address serves two principal functions: host or network interface identification and location addressing. + +Valid IP could be either IPv4 ~~or IPv6~~ + ## IPv4 -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +Internet Protocol Version 4 (IPv4) is the fourth revision of the Internet Protocol and a widely used protocol in data communication over different kinds of networks. + +IPv4 is a connectionless protocol used in packet-switched layer networks, such as Ethernet. + +More documentation can be found on [that URL](https://en.wikipedia.org/wiki/IPv6) + + +## IPv6 + + +Internet Protocol Version 6 (IPv6) is an Internet Protocol (IP) used for carrying data in packets from a source to a destination over various networks. + +IPv6 is the enhanced version of IPv4 and can support very large numbers of nodes as compared to IPv4. + +It allows for 2128 possible node, or address, combinations. + +More documentation can be found on [that URL](https://en.wikipedia.org/wiki/IPv6) + +**NOTE:** This function is experimental please report any issue with that. + ## Identifier -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +An Identifier should be shorter than 253 chars and lc alphanum or . or - + ## Integer @@ -250,13 +293,15 @@ Therefore, the numbers 10, 0, -25, and 5,148 are all integers. Unlike floating p ## List -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +This field is enforcing a check to a field to determinate if a list was actually provided as parameter. + ## NonEmpty -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +This wrapper is ensuring that a field could not be left empty but needs to have a valid value. + ## NonZero @@ -278,8 +323,15 @@ An integer is a whole number (not a fraction) that can be positive, negative, fl ## Path -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +A path, the general form of the name of a file or directory, specifies a unique location in a file system. +A path points to a file system location by following the directory tree hierarchy expressed in a string of characters in which path components, separated by a delimiting character, represent each directory. +The delimiting character is most commonly the slash ("/"), the backslash character (""), or colon (":"), though some operating systems may use a different delimiter. +Paths are used extensively in computer science to represent the directory/file relationships common in modern operating systems, and are essential in the construction of Uniform Resource Locators (URLs). +Resources can be represented by either absolute or relative paths. + +More info could be fount [here](https://en.wikipedia.org/wiki/Path_(computing)) + ## Positive @@ -289,18 +341,21 @@ Define a number that needs to be positive (0 is included as positive) ## String -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +String is any finite sequence of characters (i.e., letters, numerals, symbols and punctuation marks). + ## SurgeSpec -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +SurgeSpec is expection surge/unavailable type ie integer or percent + ## SystemIdentifier -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +An Identifier should be shorten than 253 chars and lc alphanum or . or - or : + # Objects diff --git a/lib/kube_types.py b/lib/kube_types.py index 02e8a36..4c1ca3a 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -217,6 +217,9 @@ def do_check(self, value, path): class String(KubeType): + """ + String is any finite sequence of characters (i.e., letters, numerals, symbols and punctuation marks). + """ validation_text = "Expected string" def do_check(self, value, path): @@ -226,6 +229,9 @@ def do_check(self, value, path): class SurgeSpec(KubeType): + """ + SurgeSpec is expection surge/unavailable type ie integer or percent + """ validation_text = "Expected surge/unavailable type ie integer or percent" def do_check(self, value, path): @@ -262,6 +268,13 @@ def check_zero(v): class IPv4(String): + """ + Internet Protocol Version 4 (IPv4) is the fourth revision of the Internet Protocol and a widely used protocol in data communication over different kinds of networks. + + IPv4 is a connectionless protocol used in packet-switched layer networks, such as Ethernet. + + More documentation can be found on [that URL](https://en.wikipedia.org/wiki/IPv6) + """ validation_text = "Expected an IPv4 address" def do_check(self, value, path): @@ -285,7 +298,43 @@ def comp_ok(x): return True +class IPv6(String): + """ + Internet Protocol Version 6 (IPv6) is an Internet Protocol (IP) used for carrying data in packets from a source to a destination over various networks. + + IPv6 is the enhanced version of IPv4 and can support very large numbers of nodes as compared to IPv4. + + It allows for 2128 possible node, or address, combinations. + + More documentation can be found on [that URL](https://en.wikipedia.org/wiki/IPv6) + + **NOTE:** This function is experimental please report any issue with that. + """ + validation_text = "Expected an IPv6 address" + def do_check(self, value, path): + # Needs to be a string in first place + if not String.do_check(self, value, path): + return False + + valid_characters = 'ABCDEFabcdef:0123456789' + is_valid = all(current in valid_characters for current in value) + address_list = value.split(':') + valid_segment = all(len(current) <= 4 for current in address_list) + + if is_valid and valid_segment and len(address_list) == 8: + return True + else: + return False + + class IP(String): + """ + An Internet Protocol address (IP address) is a numerical label assigned to each device connected to a computer network that uses the Internet Protocol for communication. + + An IP address serves two principal functions: host or network interface identification and location addressing. + + Valid IP could be either IPv4 ~~or IPv6~~ + """ validation_text = "Expected an IP address" def do_check(self, value, path): @@ -293,6 +342,23 @@ def do_check(self, value, path): class Domain(String): + """ + The definitive descriptions of the rules for forming domain names appear in [RFC 1035](https://tools.ietf.org/html/rfc1035), [RFC 1123](https://tools.ietf.org/html/rfc1123), and [RFC 2181](https://tools.ietf.org/html/rfc2181). A domain name consists of one or more parts, technically called labels, that are conventionally concatenated, and delimited by dots, such as `example.com`. + + The right-most label conveys the top-level domain; for example, the domain name `www.example.com` belongs to the top-level domain `com`. + + The hierarchy of domains descends from right to left; each label to the left specifies a subdivision, or subdomain of the domain to the right. For example, the label example specifies a subdomain of the com domain, and www is a subdomain of example.com. + This tree of subdivisions may have up to 127 levels. + + A label may contain zero to 63 characters. The null label, of length zero, is reserved for the root zone. + The full domain name may not exceed the length of 253 characters in its textual representation.In the internal binary representation of the DNS the maximum length requires 255 octets of storage, as it also stores the length of the name. + + Although no technical limitation exists to use any character in domain name labels which are representable by an octet, hostnames use a preferred format and character set. + The characters allowed in labels are a subset of the ASCII character set, consisting of characters a through z, A through Z, digits 0 through 9, and hyphen. + This rule is known as the LDH rule (letters, digits, hyphen). + Domain names are interpreted in case-independent manner. + Labels may not start or end with a hyphen. An additional rule requires that top-level domain names should not be all-numeric.[20] + """ validation_text = "Expected a domain name" def do_check(self, value, path): @@ -317,6 +383,9 @@ def comp_ok(x): class Identifier(String): + """ + An Identifier should be shorter than 253 chars and lc alphanum or . or - + """ validation_text = "Identifiers should be <253 chars and lc alphanum or . or -" def do_check(self, value, path): @@ -332,6 +401,9 @@ def do_check(self, value, path): class CaseIdentifier(Identifier): + """ + An Identifier should be shorten thsn 253 chars and alphanum or . or - + """ validation_text = "Identifiers should be <253 chars and alphanum or . or -" def do_check(self, value, path): @@ -347,6 +419,9 @@ def do_check(self, value, path): class SystemIdentifier(Identifier): + """ + An Identifier should be shorten than 253 chars and lc alphanum or . or - or : + """ validation_text = "Identifiers should be <253 chars and lc alphanum or . or - or :" def do_check(self, value, path): @@ -367,6 +442,9 @@ def do_check(self, value, path): class ColonIdentifier(Identifier): + """ + An Identifier should be shorten than 253 chars and lc alphanum or . or - or : + """ validation_text = "Identifiers should be <253 chars and lc alphanum or . or - and a :" def do_check(self, value, path): @@ -430,6 +508,15 @@ def do_check(self, value, path): class Path(String): + """ + A path, the general form of the name of a file or directory, specifies a unique location in a file system. + A path points to a file system location by following the directory tree hierarchy expressed in a string of characters in which path components, separated by a delimiting character, represent each directory. + The delimiting character is most commonly the slash ("/"), the backslash character ("\"), or colon (":"), though some operating systems may use a different delimiter. + Paths are used extensively in computer science to represent the directory/file relationships common in modern operating systems, and are essential in the construction of Uniform Resource Locators (URLs). + Resources can be represented by either absolute or relative paths. + + More info could be fount [here](https://en.wikipedia.org/wiki/Path_(computing)) + """ validation_text = "Expecting a fully qualified path" def do_check(self, value, path): @@ -439,6 +526,9 @@ def do_check(self, value, path): class NonEmpty(KubeType): + """ + This wrapper is ensuring that a field could not be left empty but needs to have a valid value. + """ validation_text = "Expecting non-empty" wrapper = True @@ -448,6 +538,9 @@ def do_check(self, value, path): class OneOf(KubeType): + """ + This wrapper is defininig the possibility for a field to be either multiple types. + """ def __init__(self, *types): assert len(types) > 1 self.types = list(map(self.__class__.construct_arg, types)) @@ -479,6 +572,9 @@ def check(self, value, path=None): class List(KubeType): + """ + This field is enforcing a check to a field to determinate if a list was actually provided as parameter. + """ validation_text = "Expecting list" wrapper = True From ee20fbfcf1ef9eed582df7f24699c73dee32a2c0 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 11:13:24 +0200 Subject: [PATCH 36/40] Added description on nullable --- docs/rubiks.class.md | 5 +++-- lib/kube_types.py | 3 +++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 8964aca..8e35cd4 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -312,8 +312,9 @@ Will be accepted positive and negative of any kind. ## Nullable -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +This wrapper if telling to rubiks that the parameter could be some valid value or null(None in python) + ## Number diff --git a/lib/kube_types.py b/lib/kube_types.py index 4c1ca3a..d289d3e 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -119,6 +119,9 @@ def do_check(self, value, path): class Nullable(KubeType): + """ + This wrapper if telling to rubiks that the parameter could be some valid value or null(None in python) + """ validation_text = "Expected type or None" wrapper = True From 847dcf638023ccfd022c5fc264f885149990ea99 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Mon, 9 Jul 2018 11:33:56 +0200 Subject: [PATCH 37/40] Added more docs --- docs/rubiks.class.md | 25 +++++++++++++++---------- lib/kube_vartypes.py | 15 +++++++++++++++ 2 files changed, 30 insertions(+), 10 deletions(-) diff --git a/docs/rubiks.class.md b/docs/rubiks.class.md index 8e35cd4..be6dcf1 100644 --- a/docs/rubiks.class.md +++ b/docs/rubiks.class.md @@ -135,28 +135,33 @@ It is possible to generate this documentation locally running inside your rubiks ## Base64 -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +It is representing a [base64](https://en.wikipedia.org/wiki/Base64) encoded strign + ## Command -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +It is representing a docker command to be executed by kubernetes in the process of spinning up a new Pod + ## Confidential -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +It is representing a confidential/secret string that needs to not be displayed publicly + ## JSON -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +It is representing a [JSON](https://en.wikipedia.org/wiki/JSON) object + ## YAML -TODO: Description is still missing from the class docstring. -Stay tuned to have more hint about this variable. + +It is representing a [YAML](https://en.wikipedia.org/wiki/YAML) object + # Types diff --git a/lib/kube_vartypes.py b/lib/kube_vartypes.py index 664554a..2499d25 100644 --- a/lib/kube_vartypes.py +++ b/lib/kube_vartypes.py @@ -17,6 +17,9 @@ class Base64(var_types.VarEntity): + """ + It is representing a [base64](https://en.wikipedia.org/wiki/Base64) encoded strign + """ def init(self, value): self.value = value @@ -32,6 +35,9 @@ def to_string(self): class JSON(var_types.VarEntity): + """ + It is representing a [JSON](https://en.wikipedia.org/wiki/JSON) object + """ def init(self, value): self.value = value self.args = {'indent': None, 'separators': (',',':')} @@ -48,6 +54,9 @@ def _default_json(obj): class YAML(var_types.VarEntity): + """ + It is representing a [YAML](https://en.wikipedia.org/wiki/YAML) object + """ def init(self, value): self.value = value @@ -59,6 +68,9 @@ def to_string(self): class Confidential(var_types.VarEntity): + """ + It is representing a confidential/secret string that needs to not be displayed publicly + """ def init(self, value): self.value = value @@ -78,6 +90,9 @@ class CommandRuntimeException(Exception): class Command(var_types.VarEntity): + """ + It is representing a docker command to be executed by kubernetes in the process of spinning up a new Pod + """ def init(self, cmd, cwd=None, env_clear=False, env=None, good_rc=None, rstrip=False, eol=False): self.cmd = cmd self.cwd = cwd From 24899a83828e0f91fc5f28819ad6bfc9f62b163f Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Wed, 18 Jul 2018 09:57:18 +0200 Subject: [PATCH 38/40] Fix on Copyright --- lib/commands/docgen.py | 2 +- lib/kube_help.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index fa1dc04..2c19377 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -1,4 +1,4 @@ -# (c) Copyright 2018-2019 OLX +# (c) Copyright 2017-2018 OLX from __future__ import absolute_import from __future__ import division diff --git a/lib/kube_help.py b/lib/kube_help.py index 0432a57..b417121 100644 --- a/lib/kube_help.py +++ b/lib/kube_help.py @@ -1,4 +1,4 @@ -# (c) Copyright 2018-2019 OLX +# (c) Copyright 2017-2018 OLX from __future__ import absolute_import from __future__ import division From 076041783cf77fb03ba0cb243faa84becbcdbb79 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Wed, 18 Jul 2018 10:02:36 +0200 Subject: [PATCH 39/40] Fix on documentation --- lib/commands/docgen.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/commands/docgen.py b/lib/commands/docgen.py index 2c19377..97996ef 100644 --- a/lib/commands/docgen.py +++ b/lib/commands/docgen.py @@ -12,6 +12,10 @@ class Command_docgen(Command, CommandRepositoryBase): """ + Generate the documentation of all classes supported by rubiks on your local rubiks folder. + """ + + _documentation = """ This document is automatically generated using the command `docgen` and describe all the object and types that can be used inside Rubiks to configure your cluster It is possible to generate this documentation locally running inside your rubiks repo `rubiks docgen`. @@ -27,7 +31,7 @@ def run(self, args): r = self.get_repository() - doc = '\n'.join([line.strip() for line in self.__class__.__doc__.split('\n')]) + doc = '\n'.join([line.strip() for line in self._documentation.split('\n')]) md = '' header = '

\n\n' From f0a1bd2a1da124244cbabb1f0961505d79601db5 Mon Sep 17 00:00:00 2001 From: Gabriel Melillo Date: Thu, 19 Jul 2018 10:34:22 +0200 Subject: [PATCH 40/40] Temp --- lib/kube_types.py | 21 +++++++++------------ 1 file changed, 9 insertions(+), 12 deletions(-) diff --git a/lib/kube_types.py b/lib/kube_types.py index d289d3e..e3c8283 100644 --- a/lib/kube_types.py +++ b/lib/kube_types.py @@ -64,15 +64,12 @@ def original_type(self): return self.wrap.original_type() return None - def name(self, md=False): + def name(self, render=None): + if render is None: + render = lambda x: x if self.wrapper: - if md: - return '[{}](#{})<{}>'.format(self.__class__.__name__, self.__class__.__name__.lower(), self.wrap.name(md=True)) - else: - return '{}<{}>'.format(self.__class__.__name__, self.wrap.name()) - if md: - return '[{}](#{})'.format(self.__class__.__name__, self.__class__.__name__.lower()) - return self.__class__.__name__ + return '{}<{}>'.format(render(self.__class__.__name__), self.wrap.name(render=render)) + return render(self.__class__.__name__) def check_wrap(self, value, path): if self.wrapper: @@ -103,10 +100,10 @@ def __init__(self, cls): def original_type(self): return self.cls - def name(self, md=False): - if md: - return '[{}](#{})'.format(self.cls.__name__, self.cls.__name__.lower()) - return self.cls.__name__ + def name(self, render=None): + if render is None: + render = lambda x: x + return render(self.cls.__name__) def do_check(self, value, path): self.validation_text = "Not the right object type"