Skip to content

Commit

Permalink
Merge pull request rancher#492 from deniseschannon/sepupdates
Browse files Browse the repository at this point in the history
Updated typo in all versions/langs
  • Loading branch information
Denise authored Sep 23, 2016
2 parents 4baab70 + 76c6257 commit d84bd17
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 48 deletions.
27 changes: 13 additions & 14 deletions rancher/v1.0/en/rancher-compose/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ lang: en
## Rancher Compose Command and Options
---

The `rancher-compose` tool works just like the popular `docker-compose` and supports the V1 version of `docker-compose.yml` files. To enable features that are supported in Rancher, you can also have a `rancher-compose.yml` which extends and overwrites the `docker-compose.yml`. For example, scale of servives and health checks would be in the `rancher-compose.yml` file.
The `rancher-compose` tool works just like the popular `docker-compose` and supports the V1 version of `docker-compose.yml` files. To enable features that are supported in Rancher, you can also have a `rancher-compose.yml` which extends and overwrites the `docker-compose.yml`. For example, scale of services and health checks would be in the `rancher-compose.yml` file.

## Rancher-Compose Commands
---
Expand All @@ -32,7 +32,7 @@ Name | Description
## Rancher-Compose Options
---

Whenever you use the `rancher-compose` command, there are different options that you can use.
Whenever you use the `rancher-compose` command, there are different options that you can use.

Name | Description
--- | ---
Expand All @@ -49,9 +49,9 @@ Name | Description

<br>

### Examples
### Examples

To get started, you can create a simple `docker-compose.yml` file and optionally a `rancher-compose.yml` file. If there is no `rancher-compose.yml` file, then all services will start with a scale of 1 container.
To get started, you can create a simple `docker-compose.yml` file and optionally a `rancher-compose.yml` file. If there is no `rancher-compose.yml` file, then all services will start with a scale of 1 container.

Sample `docker-compose.yml`

Expand All @@ -68,10 +68,10 @@ web:
scale: 2
```

After your files are created, you can launch the services into Rancher server.
After your files are created, you can launch the services into Rancher server.

```bash
# Creating and starting a service without environment variables and selecting a stack
# Creating and starting a service without environment variables and selecting a stack
# If the stack does not exist in Rancher, it will be created in Rancher
$ rancher-compose --url URL_of_Rancher --access-key <username_of_environment_api_key> --secret-key <password_of_environment_api_key> -p stack1 up
Expand Down Expand Up @@ -104,10 +104,10 @@ Name | Description

<br>

When you run the `up` command with `rancher-compose`, after all the tasks are complete, the process continues to run. If you want the process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.
When you run the `up` command with `rancher-compose`, after all the tasks are complete, the process continues to run. If you want the process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.

```bash
# If you do not use the -d flag, rancher-compose will continue to run until you Ctrl+C to quit
# If you do not use the -d flag, rancher-compose will continue to run until you Ctrl+C to quit
$ rancher-compose up
# Use the -d flag for rancher-compose to exit after running
Expand All @@ -124,7 +124,7 @@ Name | Description

<br>

If you want the start process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.
If you want the start process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.

### Logs Command

Expand All @@ -141,15 +141,15 @@ Name | Description

<br>

By default, restarting services will restart the containers individually and immediately sequentially. You can set the batch size and interval of the restart policy.
By default, restarting services will restart the containers individually and immediately sequentially. You can set the batch size and interval of the restart policy.

### Stop/Down & Scale Command

Name | Description
---|----
`--timeout`, `-t` `"10"` | Specify a shutdown timeout in seconds.

<br>
<br>

```yaml
# To change the scale of an existing service
Expand All @@ -164,7 +164,7 @@ Name | Description

When removing services, `rancher-compose` will only delete the services that are found in the `docker-compose.yml`. If there are more services within the stack in Rancher, they will not be deleted as rancher-compose will not know they exist.

Also, the stack will not be deleted as rancher-compose will not be aware if there are any remaining services.
Also, the stack will not be deleted as rancher-compose will not be aware if there are any remaining services.


### Pull Command
Expand All @@ -185,7 +185,7 @@ $ rancher-compose pull --cached

<br>

> **Note:** Unlike `docker-compose pull`, you will not be specifying which service to pull. Rancher-compose looks at all services in the `docker-compose.yml` and pulls images for all services found in the file.
> **Note:** Unlike `docker-compose pull`, you will not be specifying which service to pull. Rancher-compose looks at all services in the `docker-compose.yml` and pulls images for all services found in the file.

### Upgrade Command

Expand All @@ -196,4 +196,3 @@ You can upgrade your services in Rancher using `rancher-compose`. Please read mo
---

`rancher-compose` will not delete things by default. This means that if you do two `up` commands in a row, the second `up` will do nothing. This is because the first up will create everything and leave it running. Even if you do not pass `-d` to `up`, `rancher-compose` will not delete your services. To delete a service you must use `rm`.

31 changes: 15 additions & 16 deletions rancher/v1.1/en/cattle/rancher-compose/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ lang: en
## Command and Options
---

The Rancher Compose tool works just like the popular Docker Compose and supports the V1 version of `docker-compose.yml` files. To enable features that are supported in Rancher, you can also have a `rancher-compose.yml` which extends and overwrites the `docker-compose.yml`. For example, scale of servives and health checks would be in the `rancher-compose.yml` file.
The Rancher Compose tool works just like the popular Docker Compose and supports the V1 version of `docker-compose.yml` files. To enable features that are supported in Rancher, you can also have a `rancher-compose.yml` which extends and overwrites the `docker-compose.yml`. For example, scale of services and health checks would be in the `rancher-compose.yml` file.

### Rancher-Compose Commands

Expand All @@ -30,7 +30,7 @@ Name | Description

### Rancher Compose Options

Whenever you use the Rancher Compose command, there are different options that you can use.
Whenever you use the Rancher Compose command, there are different options that you can use.

Name | Description
--- | ---
Expand All @@ -45,9 +45,9 @@ Name | Description
`--help`, `-h` | show help
`--version`, `-v` | print the version

#### Examples
#### Examples

To get started, you can create a simple `docker-compose.yml` file and optionally a `rancher-compose.yml` file. If there is no `rancher-compose.yml` file, then all services will start with a scale of 1 container.
To get started, you can create a simple `docker-compose.yml` file and optionally a `rancher-compose.yml` file. If there is no `rancher-compose.yml` file, then all services will start with a scale of 1 container.

##### Example `docker-compose.yml`

Expand All @@ -64,10 +64,10 @@ web:
scale: 2
```

After your files are created, you can launch the services into Rancher server.
After your files are created, you can launch the services into Rancher server.

```bash
# Creating and starting a service without environment variables and selecting a stack
# Creating and starting a service without environment variables and selecting a stack
# If the stack does not exist in Rancher, it will be created in Rancher
$ rancher-compose --url URL_of_Rancher --access-key <username_of_environment_api_key> --secret-key <password_of_environment_api_key> -p stack1 up
Expand All @@ -84,7 +84,7 @@ $ rancher-compose -p stack1 scale service1=3

#### Using the `--env-file` Option

You can pass in a file of environment variables using `--env-file` while running a Rancher Compose command.
You can pass in a file of environment variables using `--env-file` while running a Rancher Compose command.

##### Example `secrets` file

Expand All @@ -103,7 +103,7 @@ environment:
MYSQL_ROOT_PASSWORD:
```

You can launch your service and pass in the `secrets` file.
You can launch your service and pass in the `secrets` file.

```bash
$ rancher-compose --env-file secrets up -d
Expand All @@ -128,10 +128,10 @@ Name | Description

<br>

When you run the `up` command with Rancher Compose, after all the tasks are complete, the process continues to run. If you want the process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.
When you run the `up` command with Rancher Compose, after all the tasks are complete, the process continues to run. If you want the process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.

```bash
# If you do not use the -d flag, Rancher Compose will continue to run until you Ctrl+C to quit
# If you do not use the -d flag, Rancher Compose will continue to run until you Ctrl+C to quit
$ rancher-compose up

# Use the -d flag for rancher-compose to exit after running
Expand All @@ -148,7 +148,7 @@ Name | Description

<br>

If you want the start process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.
If you want the start process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.

#### Logs Command

Expand All @@ -166,15 +166,15 @@ Name | Description

<br>

By default, restarting services will restart the containers individually and immediately sequentially. You can set the batch size and interval of the restart policy.
By default, restarting services will restart the containers individually and immediately sequentially. You can set the batch size and interval of the restart policy.

#### Stop/Down & Scale Command

Name | Description
---|----
`--timeout`, `-t` `"10"` | Specify a shutdown timeout in seconds.

<br>
<br>

```yaml
# To change the scale of an existing service
Expand All @@ -192,7 +192,7 @@ Name | Description

When removing services, Rancher Compose will only delete the services that are found in the `docker-compose.yml`. If there are more services within the stack in Rancher, they will not be deleted as Rancher Compose will not know they exist.

Also, the stack will not be deleted as Rancher Compose will not be aware if there are any remaining services.
Also, the stack will not be deleted as Rancher Compose will not be aware if there are any remaining services.

By default, volumes attached to containers will not be removed. You can see all volumes with `docker volume ls`.

Expand All @@ -214,7 +214,7 @@ $ rancher-compose pull --cached

<br>

> **Note:** Unlike `docker-compose pull`, you will not be specifying which service to pull. Rancher Compose looks at all services in the `docker-compose.yml` and pulls images for all services found in the file.
> **Note:** Unlike `docker-compose pull`, you will not be specifying which service to pull. Rancher Compose looks at all services in the `docker-compose.yml` and pulls images for all services found in the file.
#### Upgrade Command

Expand All @@ -224,4 +224,3 @@ You can upgrade your services in Rancher using Rancher Compose. Please read more
### Deleting Services/Container

Rancher Compose will not delete things by default. This means that if you do two `up` commands in a row, the second `up` will do nothing. This is because the first up will create everything and leave it running. Even if you do not pass `-d` to `up`, Rancher Compose will not delete your services. To delete a service you must use `rm`.

31 changes: 15 additions & 16 deletions rancher/v1.1/zh/cattle/rancher-compose/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ lang: zh
## Command and Options
---

The Rancher Compose tool works just like the popular Docker Compose and supports the V1 version of `docker-compose.yml` files. To enable features that are supported in Rancher, you can also have a `rancher-compose.yml` which extends and overwrites the `docker-compose.yml`. For example, scale of servives and health checks would be in the `rancher-compose.yml` file.
The Rancher Compose tool works just like the popular Docker Compose and supports the V1 version of `docker-compose.yml` files. To enable features that are supported in Rancher, you can also have a `rancher-compose.yml` which extends and overwrites the `docker-compose.yml`. For example, scale of services and health checks would be in the `rancher-compose.yml` file.

### Rancher-Compose Commands

Expand All @@ -30,7 +30,7 @@ Name | Description

### Rancher Compose Options

Whenever you use the Rancher Compose command, there are different options that you can use.
Whenever you use the Rancher Compose command, there are different options that you can use.

Name | Description
--- | ---
Expand All @@ -45,9 +45,9 @@ Name | Description
`--help`, `-h` | show help
`--version`, `-v` | print the version

#### Examples
#### Examples

To get started, you can create a simple `docker-compose.yml` file and optionally a `rancher-compose.yml` file. If there is no `rancher-compose.yml` file, then all services will start with a scale of 1 container.
To get started, you can create a simple `docker-compose.yml` file and optionally a `rancher-compose.yml` file. If there is no `rancher-compose.yml` file, then all services will start with a scale of 1 container.

##### Example `docker-compose.yml`

Expand All @@ -64,10 +64,10 @@ web:
scale: 2
```

After your files are created, you can launch the services into Rancher server.
After your files are created, you can launch the services into Rancher server.

```bash
# Creating and starting a service without environment variables and selecting a stack
# Creating and starting a service without environment variables and selecting a stack
# If the stack does not exist in Rancher, it will be created in Rancher
$ rancher-compose --url URL_of_Rancher --access-key <username_of_environment_api_key> --secret-key <password_of_environment_api_key> -p stack1 up
Expand All @@ -84,7 +84,7 @@ $ rancher-compose -p stack1 scale service1=3

#### Using the `--env-file` Option

You can pass in a file of environment variables using `--env-file` while running a Rancher Compose command.
You can pass in a file of environment variables using `--env-file` while running a Rancher Compose command.

##### Example `secrets` file

Expand All @@ -103,7 +103,7 @@ environment:
MYSQL_ROOT_PASSWORD:
```

You can launch your service and pass in the `secrets` file.
You can launch your service and pass in the `secrets` file.

```bash
$ rancher-compose --env-file secrets up -d
Expand All @@ -128,10 +128,10 @@ Name | Description

<br>

When you run the `up` command with Rancher Compose, after all the tasks are complete, the process continues to run. If you want the process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.
When you run the `up` command with Rancher Compose, after all the tasks are complete, the process continues to run. If you want the process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.

```bash
# If you do not use the -d flag, Rancher Compose will continue to run until you Ctrl+C to quit
# If you do not use the -d flag, Rancher Compose will continue to run until you Ctrl+C to quit
$ rancher-compose up

# Use the -d flag for Rancher Compose to exit after running
Expand All @@ -148,7 +148,7 @@ Name | Description

<br>

If you want the start process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.
If you want the start process to exit after completion, you'll need to add in the `-d` option, which is to not block and log.

#### Logs Command

Expand All @@ -166,15 +166,15 @@ Name | Description

<br>

By default, restarting services will restart the containers individually and immediately sequentially. You can set the batch size and interval of the restart policy.
By default, restarting services will restart the containers individually and immediately sequentially. You can set the batch size and interval of the restart policy.

#### Stop/Down & Scale Command

Name | Description
---|----
`--timeout`, `-t` `"10"` | Specify a shutdown timeout in seconds.

<br>
<br>

```yaml
# To change the scale of an existing service
Expand All @@ -192,7 +192,7 @@ Name | Description

When removing services, Rancher Compose will only delete the services that are found in the `docker-compose.yml`. If there are more services within the stack in Rancher, they will not be deleted as Rancher Compose will not know they exist.

Also, the stack will not be deleted as Rancher Compose will not be aware if there are any remaining services.
Also, the stack will not be deleted as Rancher Compose will not be aware if there are any remaining services.

By default, volumes attached to containers will not be removed. You can see all volumes with `docker volume ls`.

Expand All @@ -214,7 +214,7 @@ $ rancher-compose pull --cached

<br>

> **Note:** Unlike `docker-compose pull`, you will not be specifying which service to pull. Rancher Compose looks at all services in the `docker-compose.yml` and pulls images for all services found in the file.
> **Note:** Unlike `docker-compose pull`, you will not be specifying which service to pull. Rancher Compose looks at all services in the `docker-compose.yml` and pulls images for all services found in the file.
#### Upgrade Command

Expand All @@ -224,4 +224,3 @@ You can upgrade your services in Rancher using Rancher Compose. Please read more
### Deleting Services/Container

Rancher Compose will not delete things by default. This means that if you do two `up` commands in a row, the second `up` will do nothing. This is because the first up will create everything and leave it running. Even if you do not pass `-d` to `up`, Rancher Compose will not delete your services. To delete a service you must use `rm`.

2 changes: 1 addition & 1 deletion rancher/v1.2/zh/cattle/rancher-compose/commands/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ lang: zh
## Command and Options
---

The Rancher Compose tool works just like the popular Docker Compose and supports the V1 version of `docker-compose.yml` files. To enable features that are supported in Rancher, you can also have a `rancher-compose.yml` which extends and overwrites the `docker-compose.yml`. For example, scale of servives and health checks would be in the `rancher-compose.yml` file.
The Rancher Compose tool works just like the popular Docker Compose and supports the V1 version of `docker-compose.yml` files. To enable features that are supported in Rancher, you can also have a `rancher-compose.yml` which extends and overwrites the `docker-compose.yml`. For example, scale of services and health checks would be in the `rancher-compose.yml` file.

### Rancher-Compose Commands

Expand Down
2 changes: 1 addition & 1 deletion rancher/v1.2/zh/upgrading/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Rancher supports two version tags for `rancher/server`.

```bash
$ docker run -d -v <path_on_host>:/var/lib/mysql -p 8080:8080 \
--restart=unless-stopped rancher/server:latest
--restart=unless-stopped rancher/server:latest
```
<br>

Expand Down

0 comments on commit d84bd17

Please sign in to comment.