Update docs

Synchronize documentation against website
kubernetes · Jun 2, 2024 · 37ca982 · 37ca982
1 parent 6fe9738
commit 37ca982
Show file tree

Hide file tree

Showing 7 changed files with 400 additions and 406 deletions.
diff --git a/architecture.md b/architecture.md
@@ -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:
 

diff --git a/conversion.md b/conversion.md
@@ -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                    |

diff --git a/getting-started.md b/getting-started.md
@@ -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.
 

diff --git a/installation.md b/installation.md
@@ -24,24 +24,24 @@ This is the **recommended** way of installing Kompose.
 
 ```sh
 # Linux
-curl -L https://github.com/kubernetes/kompose/releases/download/v1.33.0/kompose-linux-amd64 -o kompose
+curl -L https://github.com/kubernetes/kompose/releases/download/v1.34.0/kompose-linux-amd64 -o kompose
 
 # Linux ARM64
-curl -L https://github.com/kubernetes/kompose/releases/download/v1.33.0/kompose-linux-arm64 -o kompose
+curl -L https://github.com/kubernetes/kompose/releases/download/v1.34.0/kompose-linux-arm64 -o kompose
 
 # macOS
-curl -L https://github.com/kubernetes/kompose/releases/download/v1.33.0/kompose-darwin-amd64 -o kompose
+curl -L https://github.com/kubernetes/kompose/releases/download/v1.34.0/kompose-darwin-amd64 -o kompose
 
 # macOS ARM64
-curl -L https://github.com/kubernetes/kompose/releases/download/v1.33.0/kompose-darwin-arm64 -o kompose
+curl -L https://github.com/kubernetes/kompose/releases/download/v1.34.0/kompose-darwin-arm64 -o kompose
 
 chmod +x kompose
 sudo mv ./kompose /usr/local/bin/kompose
 ```
 
 **Windows:**
 
-Download from [GitHub](https://github.com/kubernetes/kompose/releases/download/v1.33.0/kompose-windows-amd64.exe) and add the binary to your PATH.
+Download from [GitHub](https://github.com/kubernetes/kompose/releases/download/v1.34.0/kompose-windows-amd64.exe) and add the binary to your PATH.
 
 ## Go
 

diff --git a/integrations.md b/integrations.md
@@ -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:**

diff --git a/maven-example.md b/maven-example.md
@@ -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**