digital-asset/daml
1
1
Fork 0
mirror of https://github.com/digital-asset/daml.git synced 2024-09-19 16:57:40 +03:00
Code Issues Projects Releases Wiki Activity

update docker image description (#7915)

Browse Source 
Note: this file is meant to represent the content on [Docker Hub], but
syncing is currently a manual process. I will propagate once this is
approved and merged.

[Docker Hub]: https://hub.docker.com/repository/docker/digitalasset/daml-sdk

CHANGELOG_BEGIN
CHANGELOG_END
This commit is contained in:
Gary Verhaegen 2020-11-06 16:39:16 +01:00 committed by GitHub
parent 26c8a123d4
commit d4b6b06923
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 43 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
ci/docker/README.md
View File

@ -9,30 +9,60 @@ overwrite the one on Docker Hub should they differ.
# Dockerized DAML SDK # Dockerized DAML SDK
Digital Asset's [DAML SDK](https://docs.daml.com/) in a can > This image is not supported for production use-cases. Please contact Digital
> Asset to obtain supported production-ready artifacts.
Digital Asset's [DAML SDK](https://docs.daml.com/) in a can.
## Tags ## Tags
* `${SDK_VERSION}` (_Alpine Linux_) * `${SDK_VERSION}`
> Starting with tag 1.7.0, these images are signed.
## Verifying signatures
You can configure your Docker client to only pull & run signed Docker images by
setting the `DOCKER_CONTENT_TRUST` environment variable to 1.
This, however, only checks that the image is signed. If you want to further
check the provenance of the signature, you can use `docker trust inspect
--pretty digitalasset/daml-sdk:$TAG`; you should see a signer called
`automation` with the key
`533a6e09faa512f974f217668580da1ceb6aa5b00aad34ea1240afc7d249703f` and a
repository key of
`f5dc2aee6aed2d05d7eda75db7aa2b3fac7fc67afbb880d03535d5a5295a0d3b`.
## Quick start ## Quick start
* Ensure Docker is [installed](https://www.docker.com/get-started) * Ensure Docker is [installed](https://www.docker.com/get-started)
* Check out existing demo DAML project (or use your own): * Check out existing demo DAML project (or use your own):
``` ```
git clone https://github.com/digital-asset/ex-bond-trading.git git clone https://github.com/digital-asset/ex-bond-trading.git
cd ex-bond-trading cd ex-bond-trading
``` ```
* Run DAML scenarios: * Run DAML scenarios:
``` ```
docker run --rm -it -v $PWD:/data digitalasset/daml-sdk:${SDK_VERSION} bash -c "~/.daml/bin/daml test --files /data/src/main/daml/Test.daml" DOCKER_CONTENT_TRUST=1 docker run --rm -it -v $PWD:/data digitalasset/daml-sdk:$SDK_VERSION bash -c "cd \$(mktemp -d) && cp -r /data/* ./ && DAML_SDK_VERSION=$SDK_VERSION daml test"
``` ```
> Note: This image is primarily intended for CI workflows, where the benefits of caching Docker images can outweigh the awkwardness of the above command. For local development, we strongly recommend installing the DAML SDK on the host development machine instead, by running `curl https://get.daml.com | bash`. > Note: This image is primarily intended for CI workflows, where the benefits
> of caching Docker images can outweigh the awkwardness of the above command.
> For local development, we strongly recommend installing the DAML SDK on the
> host development machine instead, by running `curl https://get.daml.com |
> bash`. For production use-cases, we strongly recommend using a supported
> production binary, which can be obtained by contacting Digital Asset.
## License ## License
View [license information](https://www.apache.org/licenses/LICENSE-2.0) for the software contained in this image.
As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained). View [license information](https://www.apache.org/licenses/LICENSE-2.0) for the
software contained in this image.
As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within. As with all Docker images, these likely also contain other software which may
be under other licenses (such as Bash, etc from the base distribution, along
with any direct or indirect dependencies of the primary software being
contained).
As for any pre-built image usage, it is the image user's responsibility to
ensure that any use of this image complies with any relevant licenses for all
software contained within.