Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/googlecloudplatform/cloud-builders-community
Community-contributed images for Google Cloud Build
https://github.com/googlecloudplatform/cloud-builders-community
build docker google-cloud-build google-cloud-platform google-containers
Last synced: about 1 month ago
JSON representation
Community-contributed images for Google Cloud Build
- Host: GitHub
- URL: https://github.com/googlecloudplatform/cloud-builders-community
- Owner: GoogleCloudPlatform
- License: apache-2.0
- Created: 2017-10-24T13:49:44.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-06T15:38:22.000Z (6 months ago)
- Last Synced: 2024-05-06T17:06:19.943Z (6 months ago)
- Topics: build, docker, google-cloud-build, google-cloud-platform, google-containers
- Language: Go
- Homepage: https://cloud.google.com/cloud-build/
- Size: 10.9 MB
- Stars: 1,236
- Watchers: 58
- Forks: 850
- Open Issues: 123
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Google Cloud Build community images
This repository contains source code for community-contributed Docker images. You can use these images as build steps for
[Google Cloud Build](https://cloud.google.com/cloud-build/docs/).
These are not official Google products.
## How to use a community-contributed build step
Google Cloud Build executes a build as a series of build steps. Each build step is run in a Docker container. See
the [Cloud Build documentation](https://cloud.google.com/cloud-build/docs/overview) for more details
about builds and build steps.
### Before you begin
1. Select or create a [Google Cloud project](https://console.cloud.google.com/cloud-resource-manager).
2. Enable [billing for your project](https://support.google.com/cloud/answer/6293499#enable-billing).
3. Enable [the Cloud Build API](https://console.cloud.google.com/flows/enableapi?apiid=cloudbuild.googleapis.com).
4. Install and initialize [the Cloud SDK](https://cloud.google.com/sdk/docs/).
### Build the build step from source
To use a community-contributed Docker image as a build step, you need to download the source code from this
repo and build the image.
The example below shows how to download and build the image for the `packer` build step on a Linux or Mac OS X workstation:
1. Clone the `cloud-builders-community` repo:
```sh
$ git clone https://github.com/GoogleCloudPlatform/cloud-builders-community
```
2. Go to the directory that has the source code for the `packer` Docker image:
```sh
$ cd cloud-builders-community/packer
```
3. Build the Docker image:
```
$ gcloud builds submit --config cloudbuild.yaml .
```
4. View the image in Google Container Registry:
```sh
$ gcloud container images list --filter packer
```
### Use the build step with Cloud Build build
Once you've built the Docker image, you can use it as a build step in a Cloud Build build.
For example, below is the `packer` build step in a YAML
[config file](https://cloud.google.com/cloud-build/docs/build-config), ready to be used in a Cloud Build build:
```yaml
- name: 'gcr.io/$PROJECT_ID/packer'
args:
- build
- -var
- project_id=$PROJECT_ID
- packer.json
```
Each build step's `examples` directory has an example of how you can use the build step. See the
[example for the `packer` builder](https://github.com/GoogleCloudPlatform/cloud-builders-community/tree/master/packer/examples/gce).
## Contributing
We welcome contributions! See [CONTRIBUTING](CONTRIBUTING.md) for more information on how to get started.
Please include a `cloudbuild.yaml` and at least one working example in your
[pull request](https://help.github.com/articles/about-pull-requests/).
### Contribution Requirements
In order to accept your contribution, it must:
* make clear that the builder image is pushed to the builder's project's registry.
E.g., it specifies `images: ['gcr.io/$PROJECT_ID/the-tool']`. The builder will
not be pushed to the `gcr.io/cloud-builders` registry.
* include a simple sanity test in the `cloudbuild.yaml` config that builds and
pushes the image. This can be as simple as invoking the tool with `--help`, and
it ensures the tool is installed correctly and in the expected location within
the image.
* include some basic example describing how to use it. This helps new users get
acquainted with the builder, and helps us ensure the builder continues to work
as intended.
## License
This source code is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
## Support
To file issues and feature requests against these builder images, the usage of these build steps or the Cloud Build API in general, [create an issue in this repo](https://github.com/GoogleCloudPlatform/cloud-builders-community/issues/new).
If you are experiencing an issue with the Cloud Build service or have a feature request, e-mail [email protected] or see our [Getting support](https://cloud.google.com/cloud-build/docs/getting-support) documentation.