deep-stack/kompose
4
0
Fork 0
forked from LaconicNetwork/kompose
Code Pull Requests Activity

update references to just compose (#1869)

Browse Source 
#### 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 https://github.com/kubernetes/kompose/issues/1868

#### Special notes for your reviewer:

Signed-off-by: Charlie Drage <charlie@charliedrage.com>
This commit is contained in:
Charlie Drage
2024-04-26 10:24:55 +02:00
committed by GitHub
parent 3ce4573997
commit 50e0408f6f
13 changed files with 28 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/architecture.md
+1 -1
View File
@@ -18,7 +18,7 @@ redirect_from:
## Loader
The Loader reads the input file now `kompose` supports [Docker Compose](https://docs.docker.com/compose) v1, v2 and converts it to KomposeObject.
The Loader reads the input file now `kompose` supports [Compose](https://docs.docker.com/compose) v1, v2 and converts it to KomposeObject.
Loader is represented by a Loader interface:
docs/conversion.md
+2 -2
View File
@@ -24,7 +24,7 @@ We're doing our best to keep it up to date as soon as possible in our releases t
**Glossary:**
- **✓:** Converts
- **-:** Not in this Docker Compose Version
- **-:** Not in this Compose Version
- **n:** Not yet implemented
- **x:** Not applicable / no 1-1 conversion
@@ -90,7 +90,7 @@ We're doing our best to keep it up to date as soon as possible in our releases t
| stop_signal | x | x | x | | Not supported within Kubernetes. See issue https://github.com/kubernetes/kubernetes/issues/30051 |
| sysctls | n | n | n | | |
| ulimits | x | x | x | | Not supported within Kubernetes. See issue https://github.com/kubernetes/kubernetes/issues/3595 |
| userns_mode | x | x | x | | Not supported within Kubernetes and ignored in Docker Compose Version 3 |
| userns_mode | x | x | x | | Not supported within Kubernetes and ignored in Compose Version 3 |
| volumes | ✓ | ✓ | ✓ | PersistentVolumeClaim | Creates a PersistentVolumeClaim. Can only be created if there is already a PersistentVolume within the cluster |
| volumes: short-syntax | ✓ | ✓ | ✓ | PersistentVolumeClaim | Creates a PersistentVolumeClaim. Can only be created if there is already a PersistentVolume within the cluster |
| 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
View File
@@ -44,13 +44,13 @@ Starting cluster components...
Kubectl is now configured to use the cluster
```
**Download an [example Docker Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
**Download an [example Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
```sh
wget https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml
```
**Convert your Docker Compose file to Kubernetes:**
**Convert your Compose file to Kubernetes:**
Run `kompose convert` in the same directory as your `compose.yaml` file.
@@ -134,13 +134,13 @@ Starting local OpenShift cluster using 'kvm' hypervisor...
...
```
**Download an [example Docker Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
**Download an [example Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
```sh
wget https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml
```
**Convert your Docker Compose file to OpenShift:**
**Convert your Compose file to OpenShift:**
Run `kompose convert --provider=openshift` in the same directory as your `compose.yaml` file.
@@ -254,13 +254,13 @@ Starting local OpenShift cluster using 'kvm' hypervisor...
...
```
**Download an [example Docker Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
**Download an [example Compose file](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml), or use your own:**
```sh
wget https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml
```
**Convert your Docker Compose file to OpenShift:**
**Convert your Compose file to OpenShift:**
Run `kompose convert --provider=openshift` in the same directory as your `compose.yaml` file.
docs/integrations.md
+2 -2
View File
@@ -16,7 +16,7 @@ There are some projects out there known to use Kompose integrated in some form o
### Kompose UI by Jad Chamoun (ICANN) and Joe Haddad (Anghami)
**Description:** "A web interface to convert Docker Compose files to Kubernetes YAML"
**Description:** "A web interface to convert Compose files to Kubernetes YAML"
**Link:** [https://github.com/JadCham/komposeui](https://github.com/JadCham/komposeui)
@@ -48,7 +48,7 @@ There are some projects out there known to use Kompose integrated in some form o
**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.
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.
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.
The plugin has a wide range of configuration options. Compose is one of the options to bring up deployments on Kubernetes or OpenShift clusters.
Technically, Fabric8 Maven Plugin processes the external compose.yml file and generates Kubernetes or OpenShift resources via Kompose."
**Links:**
docs/maven-example.md
+3 -3
View File
@@ -9,7 +9,7 @@ redirect_from:
# Fabric8 Maven Plugin + Kompose:
Let's deploy a Springboot Java application with Docker Compose file using Fabric8 Maven Plugin to Kubernetes or OpenShift.
Let's deploy a Springboot Java application with Compose file using Fabric8 Maven Plugin to Kubernetes or OpenShift.
##### Requirements
@@ -46,7 +46,7 @@ $ mvn fabric8:install
This command installs the `kompose` on the host.
**4. Configure Fabric8 Maven Plugin to use a Docker Compose file**
**4. Configure Fabric8 Maven Plugin to use a Compose file**
```bash
<plugin>
@@ -66,7 +66,7 @@ This command installs the `kompose` on the host.
</plugin>
```
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`
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`
**5. Deploy application on Kubernetes or OpenShift**
docs/user-guide.md
+4 -4
View File
@@ -17,7 +17,7 @@ You can choose a targeted provider using global option `--provider`. If no provi
## Kompose Convert
Kompose supports conversion of V1, V2, and V3 Docker Compose files into Kubernetes and OpenShift objects.
Kompose supports conversion of V1, V2, and V3 Compose files into Kubernetes and OpenShift objects.
### Kubernetes
@@ -609,9 +609,9 @@ services:
#### Warning about Deployment Config's
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.
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.
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.
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.
Please note that changing service name might break some `compose` files.
@@ -621,7 +621,7 @@ To generate network policies, all you need is to use the `--generate-network-pol
## Build and push image
If the Docker Compose file has `build` or `build:context, build:dockerfile` keys, build will run when `--build` specified.
If the Compose file has `build` or `build:context, build:dockerfile` keys, build will run when `--build` specified.
And Image will push to _docker.io_ (default) when `--push-image=true` specified.