Skip to content

Commit 50e0408

Browse files
authored
update references to just compose (#1869)
#### What type of PR is this? Change from Docker Compose references to just Compose <!-- Add one of the following kinds: /kind bug /kind cleanup /kind documentation /kind feature --> #### What this PR does / why we need it: Compose is an open format and we should not say "Docker Compose". #### Which issue(s) this PR fixes: <!-- *Automatically closes linked issue when PR is merged. Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`. --> Fixes #1868 #### Special notes for your reviewer: Signed-off-by: Charlie Drage <[email protected]>
1 parent 3ce4573 commit 50e0408

File tree

13 files changed

+28
-28
lines changed

13 files changed

+28
-28
lines changed

cmd/convert.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ var (
7878

7979
var convertCmd = &cobra.Command{
8080
Use: "convert",
81-
Short: "Convert a Docker Compose file",
81+
Short: "Convert a Compose file",
8282
Example: ` kompose --file compose.yaml convert
8383
kompose -f first.yaml -f second.yaml convert
8484
kompose --provider openshift --file compose.yaml convert`,

cmd/root.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ var (
5151
// RootCmd root level flags and commands
5252
var RootCmd = &cobra.Command{
5353
Use: "kompose",
54-
Short: "A tool helping Docker Compose users move to Kubernetes",
54+
Short: "A tool helping Compose users move to Kubernetes",
5555
Long: `Kompose is a tool to help users who are familiar with docker-compose move to Kubernetes.`,
5656
Example: ` kompose --file compose.yaml convert
5757
kompose -f first.yaml -f second.yaml convert

docs/architecture.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ redirect_from:
1818

1919
## Loader
2020

21-
The Loader reads the input file now `kompose` supports [Docker Compose](https://docs.docker.com/compose) v1, v2 and converts it to KomposeObject.
21+
The Loader reads the input file now `kompose` supports [Compose](https://docs.docker.com/compose) v1, v2 and converts it to KomposeObject.
2222

2323
Loader is represented by a Loader interface:
2424

docs/conversion.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ We're doing our best to keep it up to date as soon as possible in our releases t
2424
**Glossary:**
2525

2626
- **✓:** Converts
27-
- **-:** Not in this Docker Compose Version
27+
- **-:** Not in this Compose Version
2828
- **n:** Not yet implemented
2929
- **x:** Not applicable / no 1-1 conversion
3030

@@ -90,7 +90,7 @@ We're doing our best to keep it up to date as soon as possible in our releases t
9090
| stop_signal | x | x | x | | Not supported within Kubernetes. See issue https://github.com/kubernetes/kubernetes/issues/30051 |
9191
| sysctls | n | n | n | | |
9292
| ulimits | x | x | x | | Not supported within Kubernetes. See issue https://github.com/kubernetes/kubernetes/issues/3595 |
93-
| userns_mode | x | x | x | | Not supported within Kubernetes and ignored in Docker Compose Version 3 |
93+
| userns_mode | x | x | x | | Not supported within Kubernetes and ignored in Compose Version 3 |
9494
| volumes |||| PersistentVolumeClaim | Creates a PersistentVolumeClaim. Can only be created if there is already a PersistentVolume within the cluster |
9595
| volumes: short-syntax |||| PersistentVolumeClaim | Creates a PersistentVolumeClaim. Can only be created if there is already a PersistentVolume within the cluster |
9696
| volumes: long-syntax | - | - || PersistentVolumeClaim | Creates a PersistentVolumeClaim. Can only be created if there is already a PersistentVolume within the cluster |

docs/getting-started.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ Starting cluster components...
4444
Kubectl is now configured to use the cluster
4545
```
4646

47-
**Download an [example Docker Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
47+
**Download an [example Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
4848

4949
```sh
5050
wget https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml
5151
```
5252

53-
**Convert your Docker Compose file to Kubernetes:**
53+
**Convert your Compose file to Kubernetes:**
5454

5555
Run `kompose convert` in the same directory as your `compose.yaml` file.
5656

@@ -134,13 +134,13 @@ Starting local OpenShift cluster using 'kvm' hypervisor...
134134
...
135135
```
136136

137-
**Download an [example Docker Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
137+
**Download an [example Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
138138

139139
```sh
140140
wget https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml
141141
```
142142

143-
**Convert your Docker Compose file to OpenShift:**
143+
**Convert your Compose file to OpenShift:**
144144

145145
Run `kompose convert --provider=openshift` in the same directory as your `compose.yaml` file.
146146

@@ -254,13 +254,13 @@ Starting local OpenShift cluster using 'kvm' hypervisor...
254254
...
255255
```
256256

257-
**Download an [example Docker Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
257+
**Download an [example Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
258258

259259
```sh
260260
wget https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml
261261
```
262262

263-
**Convert your Docker Compose file to OpenShift:**
263+
**Convert your Compose file to OpenShift:**
264264

265265
Run `kompose convert --provider=openshift` in the same directory as your `compose.yaml` file.
266266

docs/integrations.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ There are some projects out there known to use Kompose integrated in some form o
1616

1717
### Kompose UI by Jad Chamoun (ICANN) and Joe Haddad (Anghami)
1818

19-
**Description:** "A web interface to convert Docker Compose files to Kubernetes YAML"
19+
**Description:** "A web interface to convert Compose files to Kubernetes YAML"
2020

2121
**Link:** [https://github.com/JadCham/komposeui](https://github.com/JadCham/komposeui)
2222

@@ -48,7 +48,7 @@ There are some projects out there known to use Kompose integrated in some form o
4848

4949
**Description:** "Maven is one of the widely used build tools for Java applications. The Fabric8 Maven Plugin is a maven extension that simplifies the deployment of Java applications to Kubernetes or OpenShift clusters.
5050
The main task of this plugin is to build Docker images, generate Kubernetes or OpenShift resource descriptors and run/deploy the application on Kubernetes or OpenShift cluster.
51-
The plugin has a wide range of configuration options. Docker Compose is one of the options to bring up deployments on Kubernetes or OpenShift clusters.
51+
The plugin has a wide range of configuration options. Compose is one of the options to bring up deployments on Kubernetes or OpenShift clusters.
5252
Technically, Fabric8 Maven Plugin processes the external compose.yml file and generates Kubernetes or OpenShift resources via Kompose."
5353

5454
**Links:**

docs/maven-example.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ redirect_from:
99

1010
# Fabric8 Maven Plugin + Kompose:
1111

12-
Let's deploy a Springboot Java application with Docker Compose file using Fabric8 Maven Plugin to Kubernetes or OpenShift.
12+
Let's deploy a Springboot Java application with Compose file using Fabric8 Maven Plugin to Kubernetes or OpenShift.
1313

1414
##### Requirements
1515

@@ -46,7 +46,7 @@ $ mvn fabric8:install
4646

4747
This command installs the `kompose` on the host.
4848

49-
**4. Configure Fabric8 Maven Plugin to use a Docker Compose file**
49+
**4. Configure Fabric8 Maven Plugin to use a Compose file**
5050

5151
```bash
5252
<plugin>
@@ -66,7 +66,7 @@ This command installs the `kompose` on the host.
6666
</plugin>
6767
```
6868

69-
Add the `<configuration>` and `<executions>` sections to `pom.xml` as shown in above `pom.xml` snippet. Update the `<composeFile>` to provide the relative path of Docker Compose file from `pom.xml`
69+
Add the `<configuration>` and `<executions>` sections to `pom.xml` as shown in above `pom.xml` snippet. Update the `<composeFile>` to provide the relative path of Compose file from `pom.xml`
7070

7171
**5. Deploy application on Kubernetes or OpenShift**
7272

docs/user-guide.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ You can choose a targeted provider using global option `--provider`. If no provi
1717

1818
## Kompose Convert
1919

20-
Kompose supports conversion of V1, V2, and V3 Docker Compose files into Kubernetes and OpenShift objects.
20+
Kompose supports conversion of V1, V2, and V3 Compose files into Kubernetes and OpenShift objects.
2121

2222
### Kubernetes
2323

@@ -609,9 +609,9 @@ services:
609609

610610
#### Warning about Deployment Config's
611611

612-
If the Docker Compose file has a volume specified for a service, the Deployment (Kubernetes) or DeploymentConfig (OpenShift) strategy is changed to "Recreate" instead of "RollingUpdate" (default). This is done to avoid multiple instances of a service from accessing a volume at the same time.
612+
If the Compose file has a volume specified for a service, the Deployment (Kubernetes) or DeploymentConfig (OpenShift) strategy is changed to "Recreate" instead of "RollingUpdate" (default). This is done to avoid multiple instances of a service from accessing a volume at the same time.
613613

614-
If the Docker Compose file has service name with `_` or `.` in it (eg.`web_service` or `web.service`), then it will be replaced by `-` and the service name will be renamed accordingly (eg.`web-service`). Kompose does this because "Kubernetes" doesn't allow `_` in object name.
614+
If the Compose file has service name with `_` or `.` in it (eg.`web_service` or `web.service`), then it will be replaced by `-` and the service name will be renamed accordingly (eg.`web-service`). Kompose does this because "Kubernetes" doesn't allow `_` in object name.
615615

616616
Please note that changing service name might break some `compose` files.
617617

@@ -621,7 +621,7 @@ To generate network policies, all you need is to use the `--generate-network-pol
621621

622622
## Build and push image
623623

624-
If the Docker Compose file has `build` or `build:context, build:dockerfile` keys, build will run when `--build` specified.
624+
If the Compose file has `build` or `build:context, build:dockerfile` keys, build will run when `--build` specified.
625625

626626
And Image will push to _docker.io_ (default) when `--push-image=true` specified.
627627

index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ layout: default
44

55
# Kubernetes + Compose = Kompose
66

7-
## A conversion tool to go from Docker Compose to Kubernetes
7+
## A conversion tool to go from Compose to Kubernetes
88

99
### What's Kompose?
1010

11-
Kompose is a conversion tool for Docker Compose to container orchestrators such as Kubernetes (or OpenShift).
11+
Kompose is a conversion tool for Compose to container orchestrators such as Kubernetes (or OpenShift).
1212

1313
Why do developers love it?
1414

15-
- Simplify your development process with Docker Compose and then deploy your containers to a production cluster
15+
- Simplify your development process with Compose and then deploy your containers to a production cluster
1616
- Convert your `docker-compose.yaml` with one simple command `kompose convert`
1717

1818
### It's as simple as 1-2-3

pkg/loader/compose/compose.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ func convertDockerLabel(dockerLabel string) (string, error) {
250250
return "", errors.New(errMsg)
251251
}
252252

253-
// Convert the Docker Compose volumes to []string (the old way)
253+
// Convert the Compose volumes to []string (the old way)
254254
// TODO: Check to see if it's a "bind" or "volume". Ignore for now.
255255
// TODO: Refactor it similar to loadPorts
256256
// See: https://docs.docker.com/compose/compose-file/#long-syntax-3
@@ -273,7 +273,7 @@ func loadVolumes(volumes []types.ServiceVolumeConfig) []string {
273273
return volArray
274274
}
275275

276-
// Convert Docker Compose ports to kobject.Ports
276+
// Convert Compose ports to kobject.Ports
277277
// expose ports will be treated as TCP ports
278278
func loadPorts(ports []types.ServicePortConfig, expose []string) []kobject.Ports {
279279
komposePorts := []kobject.Ports{}

pkg/transformer/kubernetes/kubernetes.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -1270,7 +1270,7 @@ func (k *Kubernetes) CreateWorkloadAndConfigMapObjects(name string, service kobj
12701270
replica = service.Replicas
12711271
}
12721272

1273-
// Check to see if Docker Compose v3 Deploy.Mode has been set to "global"
1273+
// Check to see if Compose v3 Deploy.Mode has been set to "global"
12741274
if service.DeployMode == "global" {
12751275
//default use daemonset
12761276
if opt.Controller == "" {

script/test/fixtures/buildargs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Docker Compose Buildargs
1+
## Compose Buildargs
22

33
### Usage
44

script/test/fixtures/etherpad/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Docker Compose Etherpad
1+
## Compose Etherpad
22

33
Etherpad and Mariadb
44

0 commit comments

Comments
 (0)