root
/
kubernetes
mirror of https://github.com/kubernetes/kubernetes.git
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity
kubernetes/docs/user-guide/kubectl/kubectl_expose.md

129 lines
7.2 KiB
Markdown
Raw Normal View History

Run gendocs and munges
2015-07-12 12:04:52 +08:00
<!-- BEGIN MUNGE: UNVERSIONED_WARNING -->
<!-- BEGIN STRIP_FOR_RELEASE -->
Better scary message
2015-07-17 01:02:26 +08:00
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<img src="http://kubernetes.io/img/warning.png" alt="WARNING"
width="25" height="25">
<h2>PLEASE NOTE: This document applies to the HEAD of the source tree</h2>
If you are using a released version of Kubernetes, you should
refer to the docs that go with that version.
<strong>
The latest 1.0.x release of this document can be found
[here](http://releases.k8s.io/release-1.0/docs/user-guide/kubectl/kubectl_expose.md).
Documentation for other releases can be found at
[releases.k8s.io](http://releases.k8s.io).
</strong>
--
Run gendocs
2015-07-14 06:15:35 +08:00
Run gendocs and munges
2015-07-12 12:04:52 +08:00
<!-- END STRIP_FOR_RELEASE -->
<!-- END MUNGE: UNVERSIONED_WARNING -->
Run gendocs
2015-07-18 06:35:41 +08:00
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
## kubectl expose
Take a replicated application and expose it as Kubernetes Service
### Synopsis
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-12 01:22:08 +08:00
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
Take a replicated application and expose it as Kubernetes Service.
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-12 01:22:08 +08:00
Allow `kubectl expose` to be polymorphic to the source of the selector Allows exposing new resource types to be exposed (OpenShift deployment controllers, copying services, and other resources that will have pod label selectors). Also fixed a bug where the selector wasn't exposed because of parameter defaulting.
2015-03-26 10:35:26 +08:00
Looks up a replication controller or service by name and uses the selector for that resource as the
expose: Re-use labels in case none was specified
2015-05-13 16:52:25 +08:00
selector for a new Service on the specified port. If no labels are specified, the new service will
re-use the labels from the resource it exposes.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-12 01:22:08 +08:00
```
External IPs support.
2015-08-12 08:18:21 +08:00
kubectl expose (-f FILENAME | TYPE NAME) --port=port [--protocol=TCP|UDP] [--target-port=number-or-name] [--name=name] [----external-ip=external-ip-of-service] [--type=type]
Fix md generation for kubectl docs Display usage string, not long help, as code, remove angle brackets from output (.md interprets as tags and hides).
2015-03-12 01:22:08 +08:00
```
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
Generate new docs with the new changes
2015-02-21 05:29:23 +08:00
### Examples
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
Generate new docs with the new changes
2015-02-21 05:29:23 +08:00
```
Fixes upper case letters in kubectl examples
2015-09-02 17:56:29 +08:00
# Create a service for a replicated nginx, which serves on port 80 and connects to the containers on port 8000.
Fix typo in 'kubectl expose' examples.
2015-04-30 14:02:16 +08:00
$ kubectl expose rc nginx --port=80 --target-port=8000
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
Fixes upper case letters in kubectl examples
2015-09-02 17:56:29 +08:00
# Create a service for a replication controller identified by type and name specified in "nginx-controller.yaml", which serves on port 80 and connects to the containers on port 8000.
Kubectl expose command accepts a filename param
2015-08-11 16:38:27 +08:00
$ kubectl expose -f nginx-controller.yaml --port=80 --target-port=8000
Fixes upper case letters in kubectl examples
2015-09-02 17:56:29 +08:00
# Create a second service based on the above service, exposing the container port 8443 as port 443 with the name "nginx-https"
expose: Use resource builder Plus: * Rename flag --service-name to --name * Some refactoring
2015-05-13 20:14:44 +08:00
$ kubectl expose service nginx --port=443 --target-port=8443 --name=nginx-https
Allow `kubectl expose` to be polymorphic to the source of the selector Allows exposing new resource types to be exposed (OpenShift deployment controllers, copying services, and other resources that will have pod label selectors). Also fixed a bug where the selector wasn't exposed because of parameter defaulting.
2015-03-26 10:35:26 +08:00
Use bash comments in kubectl examples Comments in kubectl examples should use bash comments, not Go comments. So, replaces // by # for example strings.
2015-08-13 00:50:09 +08:00
# Create a service for a replicated streaming application on port 4100 balancing UDP traffic and named 'video-stream'.
expose: Use resource builder Plus: * Rename flag --service-name to --name * Some refactoring
2015-05-13 20:14:44 +08:00
$ kubectl expose rc streamer --port=4100 --protocol=udp --name=video-stream
Generate new docs with the new changes
2015-02-21 05:29:23 +08:00
```
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
### Options
```
Alias --container-port to --target-port in kubectl
2015-03-27 04:56:36 +08:00
--container-port="": Synonym for --target-port
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 22:23:28 +08:00
--dry-run[=false]: If true, only print the object that would be sent, without creating it.
External IPs support.
2015-08-12 08:18:21 +08:00
--external-ip="": External IP address to set for the service. The service can be accessed by this IP in addition to its generated service IP.
Kubectl expose command accepts a filename param
2015-08-11 16:38:27 +08:00
-f, --filename=[]: Filename, directory, or URL to a file identifying the resource to expose a service
Introduce a new service generator that leaves service port unnamed
2015-07-17 05:18:17 +08:00
--generator="service/v2": The name of the API generator to use. There are 2 generators: 'service/v1' and 'service/v2'. The only difference between them is that service port in v1 is named 'default', while it is left unnamed in v2. Default is 'service/v2'.
Update spf13/cobra with recent commits.
2015-03-24 06:09:20 +08:00
-l, --labels="": Labels to apply to the service created by this call.
expose: Better error formatting and generic flag message Re error formatting: $ osc expose svc frontend --port=5432 --generator='service/v2' --name=test Before: error: generator %!!(MISSING)q(<nil>) not found. see 'osc expose -h' for help. Now: error: generator "services/v2" not found. see 'openshift cli expose -h' for help.
2015-06-02 18:54:09 +08:00
--name="": The name for the newly created object.
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 22:23:28 +08:00
--no-headers[=false]: When using the default output, don't print headers.
change -o template to -o go-template=...
2015-08-21 21:09:41 +08:00
-o, --output="": Output format. One of: json|yaml|wide|name|go-template=...|go-template-file=...|jsonpath=...|jsonpath-file=... See golang template [http://golang.org/pkg/text/template/#pkg-overview] and jsonpath template [http://releases.k8s.io/HEAD/docs/user-guide/jsonpath.md].
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
--output-version="": Output the formatted object with the given version (default api-version).
--overrides="": An inline JSON override for the generated object. If this is non-empty, it is used to override the generated object. Requires that the object supply a valid apiVersion field.
Fixing the error message
2015-07-17 08:17:43 +08:00
--port=-1: The port that the service should serve on. Copied from the resource being exposed, if unspecified
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
--protocol="TCP": The network protocol for the service to be created. Default is 'tcp'.
--selector="": A label selector to use for this service. If empty (the default) infer the selector from the replication controller.
Add session affinity flags to kubectl expose
2015-08-01 01:34:52 +08:00
--session-affinity="": If non-empty, set the session affinity for the service to this; legal values: 'None', 'ClientIP'
Hide failed/succeeded pods in 'kubectl get pods' by default
2015-08-01 07:42:34 +08:00
-a, --show-all[=false]: When printing, show all resources (default hide terminated pods.)
Add field based sorting to the kubectl command line.
2015-08-08 14:04:25 +08:00
--sort-by="": If non-empty, sort list types using this field specification. The field specification is expressed as a JSONPath expression (e.g. 'ObjectMeta.Name'). The field in the API resource specified by this JSONPath expression must be an integer or a string.
Alias --container-port to --target-port in kubectl
2015-03-27 04:56:36 +08:00
--target-port="": Name or number for the port on the container that the service should direct traffic to. Optional.
change -o template to -o go-template=...
2015-08-21 21:09:41 +08:00
--template="": Template string or path to template file to use when -o=go-template, -o=go-template-file. The template format is golang templates [http://golang.org/pkg/text/template/#pkg-overview].
Deprecated kubectl flag "create-external-load-balancer"
2015-08-25 01:30:24 +08:00
--type="": Type for this service: ClusterIP, NodePort, or LoadBalancer. Default is 'ClusterIP'.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
```
Update docs after cobra update (spellling mistake)
2015-04-29 23:26:55 +08:00
### Options inherited from parent commands
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
```
Update docs
2015-08-18 02:06:16 +08:00
--alsologtostderr[=false]: log to standard error as well as files
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
--api-version="": The API version to use when talking to the server
--certificate-authority="": Path to a cert. file for the certificate authority.
--client-certificate="": Path to a client key file for TLS.
--client-key="": Path to a client key file for TLS.
--cluster="": The name of the kubeconfig cluster to use
--context="": The name of the kubeconfig context to use
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 22:23:28 +08:00
--insecure-skip-tls-verify[=false]: If true, the server's certificate will not be checked for validity. This will make your HTTPS connections insecure.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
--kubeconfig="": Path to the kubeconfig file to use for CLI requests.
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-17 00:44:42 +08:00
--log-backtrace-at=:0: when logging hits line file:N, emit a stack trace
Update docs
2015-08-18 02:06:16 +08:00
--log-dir="": If non-empty, write log files in this directory
Warn for every _ flag user or cmd defined also renames all global _ flags to -
2015-05-17 00:44:42 +08:00
--log-flush-frequency=5s: Maximum number of seconds between log flushes
Update docs
2015-08-18 02:06:16 +08:00
--logtostderr[=true]: log to standard error instead of files
Regen docs with new pflags This basically just shows in the docs that the =false portion of booleans are optional.
2015-08-05 22:23:28 +08:00
--match-server-version[=false]: Require server version to match client version
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
--namespace="": If present, the namespace scope for this CLI request.
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-20 03:51:38 +08:00
--password="": Password for basic authentication to the API server.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
-s, --server="": The address and port of the Kubernetes API server
--stderrthreshold=2: logs at or above this threshold go to stderr
--token="": Bearer token for authentication to the API server.
--user="": The name of the kubeconfig user to use
Merge branch 'kubectl-man' of https://github.com/eparis/kubernetes into eparis-kubectl-man Conflicts: docs/kubectl.md COMMIT_BLOCKED_ON_GENDOCS
2015-02-20 03:51:38 +08:00
--username="": Username for basic authentication to the API server.
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
--v=0: log level for V logs
--vmodule=: comma-separated list of pattern=N settings for file-filtered logging
```
### SEE ALSO
Run gendocs
2015-07-18 06:35:41 +08:00
update docs using spf13/cobra generator
2015-04-13 03:04:39 +08:00
* [kubectl](kubectl.md) - kubectl controls the Kubernetes cluster manager
Autogenerate md documentation for kubectl This does away with the giant dump from cobra for kubectl and instead generates md files which contain similar information, but one per verb. This might work well as part of the cobra project, instead of doing it in kube, but this gets us nice, linked, documentation right now. If people like it, I will try to get something similar into cobra.
2015-02-01 03:08:59 +08:00
Add a code of conduct.
2015-09-04 11:47:10 +08:00
###### Auto generated by spf13/cobra at 2015-09-10 18:53:03.159044239 +0000 UTC
Apply mungedocs changes
2015-07-14 08:13:09 +08:00
<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
move kubectl docs to docs/user-guide/kubectl
2015-07-14 01:19:25 +08:00
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/kubectl/kubectl_expose.md?pixel)]()
Apply mungedocs changes
2015-07-14 08:13:09 +08:00
<!-- END MUNGE: GENERATED_ANALYTICS -->