whentimeslows/website
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

user-guide/services: json -> yaml examples

Browse Source
This commit is contained in:
Elijah C. Voigt
2017-03-07 14:19:17 -08:00
committed by Andrew Chen
parent 1363e5b8a0
commit c942340410
1 changed files with 102 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/user-guide/services/index.md
+102 -165
View File
@@ -43,26 +43,18 @@ REST objects, a `Service` definition can be POSTed to the apiserver to create a
new instance. For example, suppose you have a set of `Pods` that each expose new instance. For example, suppose you have a set of `Pods` that each expose
port 9376 and carry a label `"app=MyApp"`. port 9376 and carry a label `"app=MyApp"`.
```json ```yaml
{ kind: Service
"kind": "Service", apiVersion: v1
"apiVersion": "v1", metadata:
"metadata": { name: my-service
"name": "my-service" spec:
}, selector:
"spec": { app: MyApp
"selector": { ports:
"app": "MyApp" - protocol: TCP
}, port: 80
"ports": [ targetPort: 9376
{
"protocol": "TCP",
"port": 80,
"targetPort": 9376
}
]
}
}
``` ```
This specification will create a new `Service` object named "my-service" which This specification will create a new `Service` object named "my-service" which
@@ -98,46 +90,31 @@ abstract other kinds of backends. For example:
In any of these scenarios you can define a service without a selector: In any of these scenarios you can define a service without a selector:
```json ```yaml
{ kind: Service
"kind": "Service", apiVersion: v1
"apiVersion": "v1", metadata:
"metadata": { name: my-service
"name": "my-service" spec:
}, ports:
"spec": { - protocol: TCP
"ports": [ port: 80
{ targetPort: 9376
"protocol": "TCP",
"port": 80,
"targetPort": 9376
}
]
}
}
``` ```
Because this service has no selector, the corresponding `Endpoints` object will not be Because this service has no selector, the corresponding `Endpoints` object will not be
created. You can manually map the service to your own specific endpoints: created. You can manually map the service to your own specific endpoints:
```json ```yaml
{ kind: Endpoints
"kind": "Endpoints", apiVersion: v1
"apiVersion": "v1", metadata:
"metadata": { name: my-service
"name": "my-service" subsets:
}, - addresses:
"subsets": [ - ip: 1.2.3.4
{ ports:
"addresses": [ - port: 9376
{ "ip": "1.2.3.4" }
],
"ports": [
{ "port": 9376 }
]
}
]
}
``` ```
NOTE: Endpoint IPs may not be loopback (127.0.0.0/8), link-local NOTE: Endpoint IPs may not be loopback (127.0.0.0/8), link-local
@@ -151,19 +128,15 @@ An ExternalName service is a special case of service that does not have
selectors. It does not define any ports or endpoints. Rather, it serves as a selectors. It does not define any ports or endpoints. Rather, it serves as a
way to return an alias to an external service residing outside the cluster. way to return an alias to an external service residing outside the cluster.
```json ```yaml
{ kind: Service
"kind": "Service", apiVersion: v1
"apiVersion": "v1", metadata:
"metadata": { name: my-service
"name": "my-service", namespace: prod
"namespace": "prod" spec:
}, type: ExternalName
"spec": { externalName: my.database.example.com
"type": "ExternalName",
"externalName": "my.database.example.com"
}
}
``` ```
When looking up the host `my-service.prod.svc.CLUSTER`, the cluster DNS service When looking up the host `my-service.prod.svc.CLUSTER`, the cluster DNS service
@@ -237,33 +210,23 @@ supports multiple port definitions on a `Service` object. When using multiple
ports you must give all of your ports names, so that endpoints can be ports you must give all of your ports names, so that endpoints can be
disambiguated. For example: disambiguated. For example:
```json ```yaml
{ kind: Service
"kind": "Service", apiVersion: v1
"apiVersion": "v1", metadata:
"metadata": { name: my-service
"name": "my-service" spec:
}, selector:
"spec": { app: MyApp
"selector": { ports:
"app": "MyApp" - name: http
}, protocol: TCP
"ports": [ port: 80
{ targetPort: 9376
"name": "http", - name: https
"protocol": "TCP", protocol: TCP
"port": 80, port: 443
"targetPort": 9376 targetPort: 9377
},
{
"name": "https",
"protocol": "TCP",
"port": 443,
"targetPort": 9377
}
]
}
}
``` ```
## Choosing your own IP address ## Choosing your own IP address
@@ -432,39 +395,26 @@ The actual creation of the load balancer happens asynchronously, and
information about the provisioned balancer will be published in the `Service`'s information about the provisioned balancer will be published in the `Service`'s
`status.loadBalancer` field. For example: `status.loadBalancer` field. For example:
```json ```yaml
{ kind: Service
"kind": "Service", apiVersion: v1
"apiVersion": "v1", metadata:
"metadata": { name: my-service
"name": "my-service" spec:
}, selector:
"spec": { app: MyApp
"selector": { ports:
"app": "MyApp" - protocol: TCP
}, port: 80
"ports": [ targetPort: 9376
{ nodePort: 30061
"protocol": "TCP", clusterIP: 10.0.171.239
"port": 80, loadBalancerIP: 78.11.24.19
"targetPort": 9376, type: LoadBalancer
"nodePort": 30061 status:
} loadBalancer:
], ingress:
"clusterIP": "10.0.171.239", - ip: 146.148.47.155
"loadBalancerIP": "78.11.24.19",
"type": "LoadBalancer"
},
"status": {
"loadBalancer": {
"ingress": [
{
"ip": "146.148.47.155"
}
]
}
}
}
``` ```
Traffic from the external load balancer will be directed at the backend `Pods`, Traffic from the external load balancer will be directed at the backend `Pods`,
@@ -479,25 +429,21 @@ For partial SSL support on clusters running on AWS, starting with 1.3 two
annotations can be added to a `LoadBalancer` service: annotations can be added to a `LoadBalancer` service:
``` ```
"metadata": { metadata:
"name": "my-service", name: my-service
"annotations": { annotations:
"service.beta.kubernetes.io/aws-load-balancer-ssl-cert": "arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012" service.beta.kubernetes.io/aws-load-balancer-ssl-cert: arn:aws:acm:us-east-1:123456789012:certificate/12345678-1234-1234-1234-123456789012
}
},
``` ```
The first specifies which certificate to use. It can be either a The first specifies which certificate to use. It can be either a
certificate from a third party issuer that was uploaded to IAM or one created certificate from a third party issuer that was uploaded to IAM or one created
within AWS Certificate Manager. within AWS Certificate Manager.
``` ```yaml
"metadata": { metadata:
"name": "my-service", name: my-service
"annotations": { annotations:
"service.beta.kubernetes.io/aws-load-balancer-backend-protocol": "(https|http|ssl|tcp)" service.beta.kubernetes.io/aws-load-balancer-backend-protocol: (https|http|ssl|tcp)
}
},
``` ```
The second annotation specifies which protocol a pod speaks. For HTTPS and The second annotation specifies which protocol a pod speaks. For HTTPS and
@@ -522,30 +468,21 @@ of the cluster administrator.
In the ServiceSpec, `externalIPs` can be specified along with any of the `ServiceTypes`. In the ServiceSpec, `externalIPs` can be specified along with any of the `ServiceTypes`.
In the example below, my-service can be accessed by clients on 80.11.12.10:80 (externalIP:port) In the example below, my-service can be accessed by clients on 80.11.12.10:80 (externalIP:port)
```json ```yaml
{ kind: Service,
"kind": "Service", apiVersion: v1,
"apiVersion": "v1", metadata:
"metadata": { name: my-service
"name": "my-service" spec:
}, selector:
"spec": { app: MyApp
"selector": { ports:
"app": "MyApp" - name: http,
}, protocol: TCP,
"ports": [ port: 80,
{ targetPort: 9376
"name": "http", externalIPs:
"protocol": "TCP", - 80.11.12.10
"port": 80,
"targetPort": 9376
}
],
"externalIPs" : [
"80.11.12.10"
]
}
}
``` ```
## Shortcomings ## Shortcomings