Skip to content

Commit

Permalink
feat: Allow to import an image from an archive (closed #80)
Browse files Browse the repository at this point in the history
  • Loading branch information
Christophe Nouguier committed Sep 25, 2019
1 parent d3b0f6c commit 0e7633d
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ The services that can be built are the following:

| command parameter | services |
| --- | --- |
| `kano` | the **Kano** application. The version to build is read from the `KANO_TAG` variable. |
| `mapproxy` | the **MapProxy** application. The version to build is read from the `MAPPROXY_TAG` variable. |
| `geoserver` | the **GeoServer**. The version as well as the list of plugins to build are read from the `GEOSERVER_TAG` and `GEOSERVER_PLUGINS` variables. |
| `maputnik` | the **maputnik**. The version to build is read from the `MAPUTNIK_TAG` variable. |
| `mapserver` | the **MapServer** application. The version to build is read from the `MAPSERVER_TAG` variable. |
| `weacast-loaders` | The list of the loaders to be build is read from the `WEACAST_MODELS` variable. For all the loaders to be built, the version and database url are read from the `WEACAST_LOADER_TAG` and `WEACAST_DB_URL` variables. |

### configure
Expand All @@ -49,6 +51,22 @@ Deploys the specified stack. The stack must be defined in the `STACKS`.

When specifying `all`, it deploys all the stacks. The stacks are deployed in the order defined in the `STACKS` variable.

### import

`usage: kargo import <service`

Import from an archive the docker image corresponding to the given service and push it into **registry**. The archive to be imported is read from the variable `<SERVICE>_ARCHIVE`. It could be an URL that point to a file on the host or a remote file. To import a remote archive, the URL must begin with:
* `http` or `https` if the archive is accessible using the **HTTP** protocol
* an existing **rclone** remote source if the archive is stored on a well-known store (i.e. Google Driver, OpenStack Object Store, AWS S3...).

The following parameters allow to import the archive `dummy-1.2.1` from a remote `bucket` using **rclone**. The source `store` must be defined in your **rclone** configuration file.

```bash
DUMMY_SERVICE=localhost:5000/dummy
DUMMY_TAG=1.2.1
DUMMY_ARCHIVE=store:bucket/dummy-1.2.1.tgz
```

### info

`usage: kargo info`
Expand Down

0 comments on commit 0e7633d

Please sign in to comment.