Skip to content

Commit f6088fb

Browse files
author
DO! DevOps bot
committed
docs: Automatic docs update
1 parent 4e2f300 commit f6088fb

1 file changed

Lines changed: 15 additions & 16 deletions

File tree

README.md

Lines changed: 15 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -102,19 +102,19 @@ See [https://github.com/dodevops/kc](the kc website) for details.
102102

103103
## Usage
104104

105-
*CloudControl* can be used best with docker-compose. Check out the `sample` directory in a flavour for a sample
105+
*CloudControl* can be used best with `docker compose`. Check out the `sample` directory in a flavour for a sample
106106
compose file and to convenience scripts. It includes a small web server written in Go and Vuejs-client dubbed
107107
"CloudControlCenter", which is used as a status screen. It listens to port 8080 inside the container.
108108

109109
Copy the compose file and configure it to your needs. Check below for configuration options per flavour and feature.
110110

111-
Run `init.sh`. This script basically just runs `docker-compose up -d` and tells you the URL for CloudControlCenter.
111+
Run `init.sh`. This script basically just runs `docker compose up -d` and tells you the URL for CloudControlCenter.
112112
Open it and wait for *CloudControl* to finish initializing.
113113

114114
The initialization process will download and configure the additional tools and completes with a message when its done.
115115
It will run each time when the stack is recreated.
116116

117-
After the initialization process you can simply run `docker-compose exec cli /usr/local/bin/cloudcontrol run` to jump
117+
After the initialization process you can simply run `docker compose exec cli /usr/local/bin/cloudcontrol run` to jump
118118
into the running container and work with the installed features.
119119

120120
If you need to change any of the configuration environment variables, rerun the init script afterwards to apply
@@ -178,7 +178,7 @@ provided base images for all architectures (e.g. the Apple ARM-based processors)
178178
for the available platforms per flavour.
179179

180180
As a workaround this, you can use the [`platform`](https://docs.docker.com/compose/compose-file/compose-file-v2/#platform)
181-
parameter for docker-compose or the `--platform` parameter for `docker run` to specify a compatible architecture
181+
parameter for `docker compose` or the `--platform` parameter for `docker run` to specify a compatible architecture
182182
(e.g. linux/amd64 on Apple ARM-based machines).
183183

184184
### How can I add an informational text for users of *CloudControl*?
@@ -191,8 +191,8 @@ set the environment variable `MOTD_DISPLAY_DEFAULT` to *yes*.
191191

192192
If you'd like to forward traffic into a cluster using `kubectl port-forward` you can do the following:
193193

194-
* Add a ports key to the cli-service in your docker-compose file to forward a free port on your host to a defined
195-
port in your container. The docker-compose-files in the sample directories already use port 8081 for this.
194+
* Add a ports key to the cli-service in your docker-compose.yaml file to forward a free port on your host to a defined
195+
port in your container. The docker-compose.yaml-files in the sample directories already use port 8081 for this.
196196

197197
* Inside *CloudControl*, check the IP of the container:
198198

@@ -218,7 +218,7 @@ kubectl port-forward --address 172.21.0.2 svc/my-service 8081:8080
218218
* Check out, which host port docker bound to the private port you set up (e.g. 8081)
219219

220220
```
221-
docker-compose port cli 8081
221+
dockercompose port cli 8081
222222
```
223223

224224
* Connect to localhost:[host port] on your host
@@ -239,7 +239,7 @@ Also, to not enter your passphrase every time you use the key, you should mount
239239
container and set the environment variable SSH_AUTH_SOCK to that path. *CloudControl* will automatically fix the
240240
permissions of that file so the *CloudControl* user can use it.
241241

242-
Here are snippets for your docker-compose file for convenience:
242+
Here are snippets for your docker-compose.yaml file for convenience:
243243

244244
(...)
245245
volumes:
@@ -271,15 +271,14 @@ messages look like this:
271271
It's hard to identify from that who the other *CloudControl* user is, that may have opened a lock. The system
272272
user can't be changed, but it's possible to set a better hostname than the one Docker autogenerated.
273273

274-
See this docker-compose snippet on how to set a better hostname:
274+
See this docker-compose.yaml snippet on how to set a better hostname:
275275

276-
version: "3"
277276
services:
278-
cli:
279-
image: "dodevops/cloudcontrol-azure:latest"
280-
hostname: "[TODO yourname]"
281-
volumes:
282-
(...)
277+
cli:
278+
image: "dodevops/cloudcontrol-azure:latest"
279+
hostname: "[TODO yourname]"
280+
volumes:
281+
(...)
283282

284283
If you set hostname in that snippet to "alice", the state lock will look like this now:
285284

@@ -313,7 +312,7 @@ Use the `docker logs` command with the failed container to see the complete log
313312
installation.
314313

315314
If you are really stuck, you can convince the container to keep running by setting "CONTINUE_ON_ERROR=yes" as an
316-
environment variable in the docker-compose file. Then you can debug with the running container.
315+
environment variable in the docker-compose.yaml file. Then you can debug with the running container.
317316

318317
## Flavours
319318

0 commit comments

Comments
 (0)