Skip to content

Commit

Permalink
Merge pull request kubernetes#16411 from feihujiang/deleteSimpleYamlD…
Browse files Browse the repository at this point in the history
…ocInUserGuide

Auto commit by PR queue bot
  • Loading branch information
k8s-merge-robot committed Nov 13, 2015
2 parents 0f7b1b4 + ef0239a commit 6a34b2c
Show file tree
Hide file tree
Showing 9 changed files with 10 additions and 124 deletions.
4 changes: 2 additions & 2 deletions docs/admin/daemons.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ but with different flags and/or different memory and cpu requests for different
### Required Fields

As with all other Kubernetes config, a DaemonSet needs `apiVersion`, `kind`, and `metadata` fields. For
general information about working with config files, see [here](../user-guide/simple-yaml.md),
[here](../user-guide/configuring-containers.md), and [here](../user-guide/working-with-resources.md).
general information about working with config files, see [deploying applications](../user-guide/deploying-applications.md),
[configuring containers](../user-guide/configuring-containers.md), and [working with resources](../user-guide/working-with-resources.md) documents.

A DaemonSet also needs a [`.spec`](../devel/api-conventions.md#spec-and-status) section.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/ingress.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ A minimal Ingress might look like:
*POSTing this to the API server will have no effect if you have not configured an [Ingress controller](#ingress-controllers).*
__Lines 1-4__: As with all other Kubernetes config, an Ingress needs `apiVersion`, `kind`, and `metadata` fields. For general information about working with config files, see [here](simple-yaml.md), [here](configuring-containers.md), and [here](working-with-resources.md).
__Lines 1-4__: As with all other Kubernetes config, an Ingress needs `apiVersion`, `kind`, and `metadata` fields. For general information about working with config files, see [deploying applications](deploying-applications.md), [configuring containers](configuring-containers.md), and [working with resources](working-with-resources.md) documents.

__Lines 5-7__: Ingress [spec](../devel/api-conventions.md#spec-and-status) has all the information needed to configure a loadbalancer or proxy server. Most importantly, it contains a list of rules matched against all incoming requests. Currently the Ingress resource only supports http rules.

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,8 +143,8 @@ $ kubectl logs pi-aiw0a
## Writing a Job Spec

As with all other Kubernetes config, a Job needs `apiVersion`, `kind`, and `metadata` fields. For
general information about working with config files, see [here](simple-yaml.md),
[here](configuring-containers.md), and [here](working-with-resources.md).
general information about working with config files, see [deploying applications](deploying-applications.md),
[configuring containers](configuring-containers.md), and [working with resources](working-with-resources.md) documents.

A Job also needs a [`.spec` section](../devel/api-conventions.md#spec-and-status).

Expand Down
4 changes: 2 additions & 2 deletions docs/user-guide/managing-deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,8 +121,8 @@ It is a recommended practice to put resources related to the same microservice o
A URL can also be specified as a configuration source, which is handy for deploying directly from configuration files checked into github:

```console
$ kubectl create -f https://raw.githubusercontent.com/GoogleCloudPlatform/kubernetes/master/docs/user-guide/replication.yaml
replicationcontrollers/nginx
$ kubectl create -f https://raw.githubusercontent.com/GoogleCloudPlatform/kubernetes/master/docs/user-guide/pod.yaml
pods/nginx
```

## Bulk operations in kubectl
Expand Down
19 changes: 0 additions & 19 deletions docs/user-guide/replication.yaml

This file was deleted.

2 changes: 1 addition & 1 deletion docs/user-guide/simple-nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ In order to access your nginx landing page, you also have to make sure that traf

### Next: Configuration files

Most people will eventually want to use declarative configuration files for creating/modifying their applications. A [simplified introduction](simple-yaml.md)
Most people will eventually want to use declarative configuration files for creating/modifying their applications. A [simplified introduction](deploying-applications.md)
is given in a different document.


Expand Down
95 changes: 1 addition & 94 deletions docs/user-guide/simple-yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,100 +31,7 @@ Documentation for other releases can be found at

<!-- END MUNGE: UNVERSIONED_WARNING -->

## Getting started with config files.

In addition to the imperative style commands described [elsewhere](simple-nginx.md), Kubernetes
supports declarative YAML or JSON configuration files. Often times config files are preferable
to imperative commands, since they can be checked into version control and changes to the files
can be code reviewed, producing a more robust, reliable and archival system.

### Running a container from a pod configuration file

```console
$ cd kubernetes
$ kubectl create -f ./pod.yaml
```

Where pod.yaml contains something like:

<!-- BEGIN MUNGE: EXAMPLE pod.yaml -->

```yaml
apiVersion: v1
kind: Pod
metadata:
name: nginx
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx
ports:
- containerPort: 80
```
[Download example](pod.yaml?raw=true)
<!-- END MUNGE: EXAMPLE pod.yaml -->
You can see your cluster's pods:
```console
$ kubectl get pods
```

and delete the pod you just created:

```console
$ kubectl delete pods nginx
```

### Running a replicated set of containers from a configuration file

To run replicated containers, you need a [Replication Controller](replication-controller.md).
A replication controller is responsible for ensuring that a specific number of pods exist in the
cluster.

```console
$ cd kubernetes
$ kubectl create -f ./replication.yaml
```

Where `replication.yaml` contains:

<!-- BEGIN MUNGE: EXAMPLE replication.yaml -->

```yaml
apiVersion: v1
kind: ReplicationController
metadata:
name: nginx
spec:
replicas: 3
selector:
app: nginx
template:
metadata:
name: nginx
labels:
app: nginx
spec:
containers:
- name: nginx
image: nginx
ports:
- containerPort: 80
```
[Download example](replication.yaml?raw=true)
<!-- END MUNGE: EXAMPLE replication.yaml -->
To delete the replication controller (and the pods it created):
```console
$ kubectl delete rc nginx
```

### This document has been subsumed by [deploying-applications.md](deploying-applications.md)

<!-- BEGIN MUNGE: GENERATED_ANALYTICS -->
[![Analytics](https://kubernetes-site.appspot.com/UA-36037335-10/GitHub/docs/user-guide/simple-yaml.md?pixel)]()
Expand Down
2 changes: 0 additions & 2 deletions examples/examples_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,6 @@ func TestExampleObjectSchemas(t *testing.T) {
"../docs/user-guide": {
"multi-pod": nil,
"pod": &api.Pod{},
"replication": &api.ReplicationController{},
"job": &extensions.Job{},
"ingress": &extensions.Ingress{},
"nginx-deployment": &extensions.Deployment{},
Expand Down Expand Up @@ -464,7 +463,6 @@ func TestReadme(t *testing.T) {
{"../README.md", []runtime.Object{&api.Pod{}}},
{"../docs/user-guide/walkthrough/README.md", []runtime.Object{&api.Pod{}}},
{"../examples/iscsi/README.md", []runtime.Object{&api.Pod{}}},
{"../docs/user-guide/simple-yaml.md", []runtime.Object{&api.Pod{}, &api.ReplicationController{}}},
}

for _, path := range paths {
Expand Down
2 changes: 1 addition & 1 deletion examples/simple-nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ In order to access your nginx landing page, you also have to make sure that traf

### Next: Configuration files

Most people will eventually want to use declarative configuration files for creating/modifying their applications. A [simplified introduction](../docs/user-guide/simple-yaml.md)
Most people will eventually want to use declarative configuration files for creating/modifying their applications. A [simplified introduction](../docs/user-guide/deploying-applications.md)
is given in a different document.


Expand Down

0 comments on commit 6a34b2c

Please sign in to comment.