Skip to content
This repository was archived by the owner on Jul 18, 2025. It is now read-only.

Commit dc8bf73

Browse files
gloursndeloof
authored andcommitted
remove references to status & render commands
Signed-off-by: Guillaume Lours <[email protected]>
1 parent 90d8144 commit dc8bf73

File tree

3 files changed

+35
-31
lines changed

3 files changed

+35
-31
lines changed

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -216,16 +216,45 @@ CNAB too. CNAB specifies three actions which `docker app` provides as commands:
216216
* `upgrade`
217217
* `uninstall`
218218

219-
Here is an example installing an Application Package, querying its status and
219+
Here is an example installing an Application Package, inspect it and
220220
then uninstalling it:
221221
```console
222222
$ docker app install examples/hello-world/example-hello-world.dockerapp --name hello
223223
Creating network hello_default
224224
Creating service hello_hello
225225
226-
$ docker app status hello
227-
ID NAME MODE REPLICAS IMAGE PORTS
228-
0m1wn7jrgkgj hello_hello replicated 1/1 hashicorp/http-echo:latest *:8080->5678/tcp
226+
$ docker app inspect hello
227+
{
228+
"Metadata": {
229+
"version": "0.1.0",
230+
"name": "hello-world",
231+
"description": "Hello, World!",
232+
"maintainers": [
233+
{
234+
"name": "user",
235+
"email": "[email protected]"
236+
}
237+
]
238+
},
239+
"Services": [
240+
{
241+
"Name": "hello",
242+
"Image": "hashicorp/http-echo",
243+
"Replicas": 1,
244+
"Ports": "8080"
245+
}
246+
],
247+
"Parameters": {
248+
"port": "8080",
249+
"text": "Hello, World!"
250+
},
251+
"Attachments": [
252+
{
253+
"Path": "bundle.json",
254+
"Size": 3189
255+
}
256+
]
257+
}
229258
230259
$ docker app uninstall hello
231260
Removing service hello_hello
@@ -350,7 +379,6 @@ Commands:
350379
ls List the installations and their last known installation result
351380
pull Pull an application package from a registry
352381
push Push an application package to a registry
353-
render Render the Compose file for an Application Package
354382
rm Remove an application
355383
upgrade Upgrade an installed application
356384
validate Checks the rendered application is syntactically correct

examples/hello-world/README.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -89,25 +89,10 @@ port 8080
8989
text Hello, World!
9090
```
9191

92-
### Render
93-
94-
You can render your application to a Compose file by running
95-
`docker app render` or even personalize the rendered Compose file by running
96-
`docker app render --set text="hello user!"`.
97-
98-
Create a `render` directory and redirect the output of `docker app render ...`
99-
to `render/docker-compose.yml`:
100-
101-
```console
102-
$ mkdir render
103-
$ docker app render --set text="Hello user!" > render/docker-compose.yml
104-
```
105-
10692
### Install
10793

10894
You directly install your application by running
109-
`docker app deploy --set text="Hello user!"` or you can use the rendered version
110-
and run `docker stack deploy render/docker-compose.yml`.
95+
`docker app deploy --set text="Hello user!"`.
11196

11297
Navigate to `http://<ip_of_your_node>:8080` with a web browser and you will see
11398
the text message. Note that `<ip_of_your_node>` is `127.0.0.1` if you installed

examples/voting-app/README.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -68,15 +68,6 @@ result:
6868
port: 5001
6969
```
7070

71-
Test your application is valid by generating a Compose file from it:
72-
73-
```console
74-
$ docker app render voting-app.dockerapp
75-
version: "3.6"
76-
services:
77-
...
78-
```
79-
8071
### Add a parameters file for an environment
8172

8273
Create a `parameters/` folder to store the parameters you would use for
@@ -125,5 +116,5 @@ vote.port 8080
125116
vote.replicas 5
126117
```
127118

128-
**Note**: You can use a parameters file for `install`, `upgrade`, and `render`
119+
**Note**: You can use a parameters file for `install` and `upgrade`
129120
as well.

0 commit comments

Comments
 (0)