Skip to content
This repository was archived by the owner on Mar 11, 2023. It is now read-only.

Commit fb0910e

Browse files
beneschbenesch
committed
Initial commit
0 parents  commit fb0910e

File tree

17 files changed

+2924
-0
lines changed

17 files changed

+2924
-0
lines changed

‎.github/workflows/release.yml‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: goreleaser
2+
3+
on:
4+
push:
5+
tags: ["*"]
6+
7+
jobs:
8+
goreleaser:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
with:
13+
fetch-depth: 0
14+
# https://github.com/actions/checkout/issues/290
15+
- run: git fetch --force --tags
16+
- uses: actions/setup-go@v2
17+
with:
18+
go-version: 1.16
19+
- uses: goreleaser/goreleaser-action@v2
20+
with:
21+
distribution: goreleaser
22+
version: latest
23+
args: release --rm-dist
24+
env:
25+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
26+
- run: make python-sdk
27+
- run: python setup.py build sdist
28+
working-directory: sdk/python
29+
- uses: pypa/gh-action-pypi-publish@master
30+
with:
31+
password: ${{ secrets.PYPI_API_TOKEN }}
32+
packages_dir: sdk/python/dist/

‎.gitignore‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
bin
2+
sdk
3+
__pycache__
4+
venv

‎.goreleaser.yml‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
archives:
2+
- id: archive
3+
name_template: "{{ .Binary }}-{{ .Tag }}-{{ .Os }}-{{ .Arch }}"
4+
builds:
5+
- goarch:
6+
- amd64
7+
- arm64
8+
goos:
9+
- darwin
10+
- windows
11+
- linux
12+
main: ./cmd/pulumi-resource-docker-buildkit
13+
binary: pulumi-resource-docker-buildkit
14+
ldflags:
15+
- -X main.version={{.Tag}}
16+
changelog:
17+
skip: true

‎CHANGELOG.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Changelog
2+
3+
All notable changes to this crate will be documented in this file.
4+
5+
The format is based on [Keep a Changelog], and this crate adheres to [Semantic
6+
Versioning].
7+
8+
## 0.1.0 - 2021-08-22
9+
10+
Initial release.
11+
12+
[Keep a Changelog]: https://keepachangelog.com/en/1.0.0/
13+
[Semantic Versioning]: https://semver.org/spec/v2.0.0.html

‎LICENSE‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright [yyyy] [name of copyright owner]
191+
192+
Licensed under the Apache License, Version 2.0 (the "License");
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

‎MAINTAINERS.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Maintainer instructions
2+
3+
To release a new version:
4+
5+
1. Make changes.
6+
7+
2. Update changelog.
8+
9+
3. Commit changes and push to GitHub.
10+
11+
4. Create the tag.
12+
13+
```
14+
version=vA.B.C
15+
git tag -a $version -m $version
16+
git push
17+
git push origin $version
18+
```

‎Makefile‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
VERSION ?= $(patsubst v%,%,$(shell git describe))
2+
3+
bin/pulumi-sdkgen-docker-buildkit: cmd/pulumi-sdkgen-docker-buildkit/*.go
4+
go build -o bin/pulumi-sdkgen-docker-buildkit ./cmd/pulumi-sdkgen-docker-buildkit
5+
6+
python-sdk: bin/pulumi-sdkgen-docker-buildkit
7+
rm -rf sdk
8+
bin/pulumi-sdkgen-docker-buildkit $(VERSION)
9+
cp README.md sdk/python/
10+
cd sdk/python/ && \
11+
sed -i.bak -e "s/\$${VERSION}/$(VERSION)/g" -e "s/\$${PLUGIN_VERSION}/$(VERSION)/g" setup.py && \
12+
rm setup.py.bak
13+
14+
.PHONY: install
15+
install:
16+
go install ./cmd/pulumi-resource-docker-buildkit

‎README.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Docker Buildkit Pulumi Provider
2+
3+
A [Pulumi](https://pulumi.com) provider that builds and pushes a Docker image to
4+
a registry using [Buildkit].
5+
6+
## Motivation
7+
8+
Why use this provider over the official [pulumi-docker] provider? This provider
9+
fixes many of the [bugs](https://github.com/pulumi/pulumi-docker/issues/132)
10+
with the official Docker provider:
11+
12+
* `pulumi preview` does not silently block while waiting for the Docker image
13+
to build.
14+
* Output from `docker build` streams to the terminal during `pulumi up`.
15+
* `docker build` is not invoked if nothing in the build context has changed.
16+
* Changes to the build context cause a diff to appear during `pulumi preview`.
17+
18+
It also provides several new features:
19+
20+
* Support for cross-building images (e.g., building a `linux/arm64` machine on
21+
a `linux/amd64` host.)
22+
* Automatic inline caching.
23+
24+
There are a few limitations though. The `Image` resource is much less
25+
configurable than the
26+
[`Image`](https://www.pulumi.com/docs/reference/pkg/docker/image/) resource in
27+
the official Docker provider. And there is no support whatsoever for the other
28+
resource types, like `Container` or `Secret`.
29+
30+
## Usage example
31+
32+
To build and push an image to an AWS ECR repository:
33+
34+
```python
35+
import base64
36+
37+
import pulumi
38+
import pulumi_aws as aws
39+
import pulumi_docker_buildkit as docker_buildkit
40+
41+
def get_registry_info(registry_id):
42+
credentials = aws.ecr.get_credentials(registry_id)
43+
username, password = base64.b64decode(credentials.authorization_token).decode().split(":")
44+
return docker_buildkit.RegistryArgs(
45+
server=credentials.proxy_endpoint,
46+
username=username,
47+
password=password,
48+
)
49+
50+
51+
repo = aws.ecr.Repository("repo")
52+
image = docker_buildkit.Image(
53+
"image",
54+
name=repo.repository_url,
55+
registry=repo.registry_id.apply(get_registry_info),
56+
)
57+
```
58+
59+
**Warning:** Be sure to aggressively exclude files in your `.dockerignore`. The
60+
`Image` resource hashes all files in the build context before determining
61+
whether to invoke `docker build`. This is fast, unless you have tens of
62+
thousands of files in your build context. The `.git` directory and
63+
`node_modules` are the usual culprits.
64+
65+
## Future plans
66+
67+
I plan to make minor bugfixes as necessary for our use of this provider at
68+
[@MaterializeInc](https://github.com/MaterializeInc). I do not currently plan to
69+
bring it to feature parity with the official Docker provider, nor do I have the
70+
time to entertain such contributions. Sorry! I encourage you to either fork this
71+
repository or to use the ideas here to improve the official Pulumi Docker
72+
provider.
73+
74+
[pulumi-docker]: https://github.com/pulumi/pulumi-docker
75+
[Buildkit]: http://github.com/moby/buildkit

0 commit comments

Comments
 (0)