From 6a871b591467000cff4953192176fa4704566a8f Mon Sep 17 00:00:00 2001 From: Charlie Drage Date: Tue, 21 Nov 2017 11:13:37 -0500 Subject: [PATCH] Rename object names to better reflect consistency Renames the object names to add "object" to the end to indicate that it's part of an array / kedge-key. Better reflects what the object is / does. --- docs/file-reference.md | 122 ++++++++++++++++++++--------------------- 1 file changed, 61 insertions(+), 61 deletions(-) diff --git a/docs/file-reference.md b/docs/file-reference.md index fd03b69f2..0cd11b34f 100644 --- a/docs/file-reference.md +++ b/docs/file-reference.md @@ -75,7 +75,7 @@ services: name: web containers: - image: nginx - # https://kubernetes.io/docs/api-reference/v1.8/#container-v1-core + # https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#container-v1-core livenessProbe: httpGet: path: / @@ -105,19 +105,19 @@ name: controller: labels: containers: - - + - volumeClaims: - - + - configMaps: - - + - services: - - + - ingresses: - routes: - secrets: - - + - imageStreams: - buildConfigs: @@ -127,7 +127,7 @@ includeResources: ``` @@ -138,16 +138,16 @@ Each "app" (Kedge file) is a Kubernetes +- ``` | Type | Required | Description | |------------------------------------------|--------------|-------| -| array of [containerSpec](#containerspec) | yes | [containerSpec](#containerspec) object | +| array of [containerObject](#containerobject) | yes | [containerObject](#containerobject) | ## volumeClaims @@ -255,19 +255,19 @@ volumeClaims: | Type | Required | Description | |------------------------------------------------|--------------|---| -| array of [persistentVolume](#persistentvolume) | no | [persistentVolume](#persistentvolume) object | +| array of [persistentVolumeObject](#persistentvolumeobject) | no | [persistentVolumeObject](#persistentvolumeobject)| ## configMaps ```yaml configMaps: -- +- ``` | Type | Required | Description | |----------------------------------|--------------|----| -| array of [configMap](#configmap) | no | [configMap](#configmap) object | +| array of [configMapObject](#configmapobject) | no | [configMapObject](#configmapobject) | ## services @@ -279,7 +279,7 @@ services: | Type | Required | Description | |------------------------------|--------------|------| -| array of [service](#service) | no | [service](#service) object | +| array of [serviceObject](#serviceobject) | no | [serviceObject](#serviceobject) | ## ingresses @@ -291,7 +291,7 @@ ingresses: | Type | Required | Description | |-------------------------------------------|--------------|------| -| array of [ingress object](#ingressobject) | no | [ingress object](#ingressobject) object | +| array of [ingressObject](#ingressobject) | no | [ingressObject](#ingressobject) | @@ -304,7 +304,7 @@ routes: | Type | Required | Description | |-------------------------------------------|--------------|------| -| array of [route object](#routeobject) | no | [route object](#routeobject) object | +| array of [routeObject](#routeobject) | no | [routeObject](#routeobject) | @@ -317,7 +317,7 @@ secrets: | Type | Required | Description | |----------------------------------|--------------|------| -| array of [secret](#secret) | no | [secret](#secret) object | +| array of [secretObject](#secretobject) | no | [secretObject](#secretobject) | ## buildConfigs @@ -360,7 +360,7 @@ This is list of files that are Kubernetes specific that can be passed to Kuberne | Type | Required | Description | |----------------------------------|--------------|------| -| array of [includeResources](#includeResources) | no | [includeResources](#includeResources) object | +| array of [includeResourceObject](#includeresourceobject) | no | [includeResourceObject](#includeresourceobject) | The file path are relative to the kedge application file. @@ -370,15 +370,15 @@ anything in the Kubernetes land. # Objects -## containerSpec +## containerObject ```yaml containers: - - + - ``` List of containers @@ -412,7 +412,7 @@ simultaneously then the tool will error out. name: web containers: - image: nginx - # https://kubernetes.io/docs/api-reference/v1.8/#container-v1-core + # https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#container-v1-core env: - name: WORDPRESS_DB_PASSWORD value: wordpress @@ -429,15 +429,15 @@ services: targetPort: 80 ``` -Anything [Container Spec](https://kubernetes.io/docs/api-reference/v1.8/#container-v1-core) from Kubernetes can be included within the Kedge file. +Anything [Container Spec](https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#container-v1-core) from Kubernetes can be included within the Kedge file. For example, keys such as `env` and `envFrom` are commonly used. -## persistentVolume +## persistentVolumeObject ```yaml volumeClaims: - - + - ``` > An example of deploying a volume @@ -461,7 +461,7 @@ volumeClaims: ``` @@ -555,7 +555,7 @@ services: volumeClaims: - name: database size: 500Mi - # https://kubernetes.io/docs/api-reference/v1.8/#persistentvolumeclaim-v1-core + # https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#persistentvolumeclaim-v1-core persistentVolumeReclaimPolicy: Recycle storageClassName: slow mountOptions: @@ -563,13 +563,13 @@ volumeClaims: - nfsvers=4.1 ``` -Anything [PersistentVolumeClaim Spec](https://kubernetes.io/docs/api-reference/v1.8/#persistentvolumeclaim-v1-core) from Kubernetes can be included within the Kedge file. +Anything [PersistentVolumeClaim Spec](https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#persistentvolumeclaim-v1-core) from Kubernetes can be included within the Kedge file. -## configMap +## configMapObject ```yaml configMaps: - - + - ``` > Example @@ -583,12 +583,12 @@ configMaps: ``` | Field | Type | Required | Description | |-------|----------|--------------|--------------| -| name | string | yes | The name of the configMap. This is optional field if only one configMap is defined, the default name will be the app name. | +| name | string | yes | The name of the configMapObject. This is optional field if only one configMapObject is defined, the default name will be the app name. | | data | object | yes | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot. | ### Name @@ -599,7 +599,7 @@ name: database | Type | Required | Description | |----------|--------------|-----| -| string | yes | The name of the configMap. This is optional field if only one configMap is defined, the default name will be the app name. | +| string | yes | The name of the configMapObject. This is optional field if only one configMapObject is defined, the default name will be the app name. | ### Data @@ -612,11 +612,11 @@ data: |----------|--------------|--------| | object | yes | Data contains the configuration data. Each key must be a valid DNS_SUBDOMAIN with an optional leading dot. | -A `configMap` is created out of this configuration. +A `configMapObject` is created out of this configuration. ### Kubernetes extension -> Example extending `configMaps` with Kubernetes ConfigMap Spec +> Example extending `configMapObjects` with Kubernetes ConfigMap Spec ```yaml name: database @@ -640,17 +640,17 @@ services: - port: 3306 configMaps: - data: - # https://kubernetes.io/docs/api-reference/v1.8/#configmap-v1-core + # https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#configmap-v1-core MYSQL_DATABASE: wordpress ``` -Anything [ConfigMap Spec](https://kubernetes.io/docs/api-reference/v1.8/#configmap-v1-core) from Kubernetes can be included. **Note:** Since Kedge already implents "data" in ConfigMaps no other keys are available to be added. +Anything [ConfigMap Spec](https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#configmap-v1-core) from Kubernetes can be included. **Note:** Since Kedge already implents "data" in ConfigMaps no other keys are available to be added. -## service +## serviceObject ```yaml services: - - + - ``` > Example @@ -666,7 +666,7 @@ services: ``` | Field | Type | Required | Description | @@ -675,7 +675,7 @@ Each "service" is a Kubernetes -Each "ingress" is a Kubernetes Ingress Spec with additional Kedge-specific keys. +Each "ingress" is a Kubernetes Ingress Spec with additional Kedge-specific keys. @@ -796,7 +796,7 @@ name: wordpress ```yaml ingresses: - name: wordpress - # https://kubernetes.io/docs/api-reference/v1.8/#ingressspec-v1beta1-extensions + # https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#ingressspec-v1beta1-extensions rules: - host: minikube.local http: @@ -807,7 +807,7 @@ ingresses: path: / ``` -Anything [Ingress Spec](https://kubernetes.io/docs/api-reference/v1.8/#ingressspec-v1beta1-extensions) from Kubernetes can be included within the Kedge file. +Anything [Ingress Spec](https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#ingressspec-v1beta1-extensions) from Kubernetes can be included within the Kedge file. ## routeObject @@ -858,7 +858,7 @@ routes: Anything [Route Spec](https://docs.openshift.org/latest/rest_api/apis-route.openshift.io/v1.Route.html#object-schema) from OpenShift can be included within the Kedge file. -## secret +## secretObject ```yaml secrets: @@ -866,7 +866,7 @@ secrets: ``` ### Name @@ -887,13 +887,13 @@ name: wordpress secrets: - name: wordpress data: - # https://kubernetes.io/docs/api-reference/v1.8/#envvarsource-v1-core + # https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#envvarsource-v1-core # Encoded in base64 MYSQL_ROOT_PASSWORD: YWRtaW4= MYSQL_PASSWORD: cGFzc3dvcmQ= ``` -Anything [EnvVarSource Spec](https://kubernetes.io/docs/api-reference/v1.8/#envvarsource-v1-core) from Kubernetes can be included within the Kedge file. +Anything [EnvVarSource Spec](https://v1-6.docs.kubernetes.io/docs/api-reference/v1.6/#envvarsource-v1-core) from Kubernetes can be included within the Kedge file. ## buildConfigObject @@ -1019,7 +1019,7 @@ imageStreams: name: "2.4" ``` -## includeResources +## includeResourceObject ```yaml includeResources: @@ -1157,4 +1157,4 @@ services: ports: - port: 8080 targetPort: 80 -``` \ No newline at end of file +```