From 5fa804c274a1f0ce1ab6e752a3852dfa94b00f19 Mon Sep 17 00:00:00 2001 From: Charlie Drage Date: Thu, 18 Jan 2024 10:11:56 -0500 Subject: [PATCH] docs: update readme (#1807) #### What type of PR is this? /kind documentation #### What this PR does / why we need it: Updates the readme by: * Removing small amount of references to Docker since Compose is an open spec * Changing to correct redis terminology #### Which issue(s) this PR fixes: N/A #### Special notes for your reviewer: N/A Signed-off-by: Charlie Drage --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d5cab327..4584f92b 100644 --- a/README.md +++ b/README.md @@ -4,21 +4,21 @@ ![logo](/docs/assets/images/logo.png) -`kompose` is a tool to help users who are familiar with `docker-compose` move to [Kubernetes](http://kubernetes.io). `kompose` takes a Docker Compose file and translates it into Kubernetes resources. +`kompose` is a tool to help users who are familiar with `docker-compose` move to [Kubernetes](http://kubernetes.io). `kompose` takes a [Compose Specification](https://compose-spec.io/) file and translates it into Kubernetes resources. -`kompose` is a convenience tool to go from local Docker development to managing your application with Kubernetes. Transformation of the Docker Compose format to Kubernetes resources manifest may not be exact, but it helps tremendously when first deploying an application on Kubernetes. +`kompose` is a convenience tool to go from local Compose environment to managing your application with Kubernetes. Transformation of the [Compose Specification](https://compose-spec.io/) format to Kubernetes resources manifest may not be exact, but it helps tremendously when first deploying an application on Kubernetes. ## Use Case -Convert [`docker-compose.yaml`](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/docker-compose.yaml) into Kubernetes deployments and services with one simple command: +Convert [`compose.yaml`](https://raw.githubusercontent.com/kubernetes/kompose/main/examples/compose.yaml) into Kubernetes deployments and services with one simple command: ```sh -$ kompose convert -f docker-compose.yaml +$ kompose convert -f compose.yaml INFO Kubernetes file "frontend-service.yaml" created -INFO Kubernetes file "redis-master-service.yaml" created +INFO Kubernetes file "redis-leader-service.yaml" created INFO Kubernetes file "redis-replica-service.yaml" created INFO Kubernetes file "frontend-deployment.yaml" created -INFO Kubernetes file "redis-master-deployment.yaml" created +INFO Kubernetes file "redis-leader-deployment.yaml" created INFO Kubernetes file "redis-replica-deployment.yaml" created ```