Skip to content

Commit

Permalink
chore: Prepare release v3.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
vprakash-seatgeek committed Aug 4, 2023
1 parent 56cad47 commit c139056
Show file tree
Hide file tree
Showing 7 changed files with 211 additions and 286 deletions.
4 changes: 2 additions & 2 deletions .chglog/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ style: github
template: CHANGELOG.tpl.md
info:
title: CHANGELOG
repository_url: https://github.com/kreuzwerker/terraform-provider-docker
repository_url: https://github.com/seatgeek/terraform-provider-docker
options:
commits:
# filters:
Expand All @@ -24,4 +24,4 @@ options:
- Subject
notes:
keywords:
- BREAKING CHANGE
- BREAKING CHANGE
361 changes: 192 additions & 169 deletions CHANGELOG.md

Large diffs are not rendered by default.

120 changes: 10 additions & 110 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,117 +1,17 @@
<a href="https://docker.com">
<img src="https://raw.githubusercontent.com/kreuzwerker/terraform-provider-docker/master/assets/docker-logo.png" alt="Docker logo" title="Docker" align="right" height="100" />
</a>
<a href="https://terraform.io">
<img src="https://raw.githubusercontent.com/kreuzwerker/terraform-provider-docker/master/assets/terraform-logo.png" alt="Terraform logo" title="Terraform" align="right" height="100" />
</a>
<a href="https://kreuzwerker.de">
<img src="https://raw.githubusercontent.com/kreuzwerker/terraform-provider-docker/master/assets/xw-logo.png" alt="Kreuzwerker logo" title="Kreuzwerker" align="right" height="100" />
</a>
# SeatGeek Fork of kreuzwerker/docker

# Terraform Provider for Docker
This repo is a SeatGeek fork of the [kreuzwerker/docker](https://github.com/kreuzwerker/terraform-provider-docker),
the Terraform Docker Provider. It contains a [single PR](https://github.com/seatgeek/terraform-provider-docker/pull/1)
that has been [submitted](https://github.com/kreuzwerker/terraform-provider-docker/pull/565) to the source repo but has
not been looked at.

[![Release](https://img.shields.io/github/v/release/kreuzwerker/terraform-provider-docker)](https://github.com/kreuzwerker/terraform-provider-docker/releases)
[![Installs](https://img.shields.io/badge/dynamic/json?logo=terraform&label=installs&query=$.data.attributes.downloads&url=https%3A%2F%2Fregistry.terraform.io%2Fv2%2Fproviders%2F713)](https://registry.terraform.io/providers/kreuzwerker/docker)
[![Registry](https://img.shields.io/badge/registry-doc%40latest-lightgrey?logo=terraform)](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/kreuzwerker/terraform-provider-docker/blob/main/LICENSE)
[![Go Status](https://github.com/kreuzwerker/terraform-provider-docker/workflows/Acc%20Tests/badge.svg)](https://github.com/kreuzwerker/terraform-provider-docker/actions)
[![Lint Status](https://github.com/kreuzwerker/terraform-provider-docker/workflows/golangci-lint/badge.svg)](https://github.com/kreuzwerker/terraform-provider-docker/actions)
[![Go Report Card](https://goreportcard.com/badge/github.com/kreuzwerker/terraform-provider-docker)](https://goreportcard.com/report/github.com/kreuzwerker/terraform-provider-docker)
The PR adds a `docker_registry_multiarch_image` data source to expose details about
[Docker multi-arch images](https://docs.docker.com/build/building/multi-platform/). When you build a multi-arch image, the
underlying images are not tagged so it is useful to be able to look up details about them. There is a usage example
available [here](examples/data-sources/docker_registry_multiarch_image/data-source.tf).

## Documentation

The documentation for the provider is available on the [Terraform Registry](https://registry.terraform.io/providers/kreuzwerker/docker/latest/docs).

Do you want to migrate from `v2.x` to `v3.x`? Please read the [migration guide](docs/v2_v3_migration.md)

## Example usage

Take a look at the examples in the [documentation](https://registry.terraform.io/providers/kreuzwerker/docker/3.0.2/docs) of the registry
or use the following example:


```hcl
# Set the required provider and versions
terraform {
required_providers {
# We recommend pinning to the specific version of the Docker Provider you're using
# since new versions are released frequently
docker = {
source = "kreuzwerker/docker"
version = "3.0.2"
}
}
}
# Configure the docker provider
provider "docker" {
}
# Create a docker image resource
# -> docker pull nginx:latest
resource "docker_image" "nginx" {
name = "nginx:latest"
keep_locally = true
}
# Create a docker container resource
# -> same as 'docker run --name nginx -p8080:80 -d nginx:latest'
resource "docker_container" "nginx" {
name = "nginx"
image = docker_image.nginx.image_id
ports {
external = 8080
internal = 80
}
}
# Or create a service resource
# -> same as 'docker service create -d -p 8081:80 --name nginx-service --replicas 2 nginx:latest'
resource "docker_service" "nginx_service" {
name = "nginx-service"
task_spec {
container_spec {
image = docker_image.nginx.repo_digest
}
}
mode {
replicated {
replicas = 2
}
}
endpoint_spec {
ports {
published_port = 8081
target_port = 80
}
}
}
```

## Building The Provider

[Go](https://golang.org/doc/install) 1.18.x (to build the provider plugin)


```sh
$ git clone [email protected]:kreuzwerker/terraform-provider-docker
$ make build
```

## Contributing

The Terraform Docker Provider is the work of many of contributors. We appreciate your help!

To contribute, please read the contribution guidelines: [Contributing to Terraform - Docker Provider](CONTRIBUTING.md)
The long term goal is to have this change accepted into the upstream and deprecate this repo.

## License

The Terraform Provider Docker is available to everyone under the terms of the Mozilla Public License Version 2.0. [Take a look the LICENSE file](LICENSE).


## Stargazers over time

[![Stargazers over time](https://starchart.cc/kreuzwerker/terraform-provider-docker.svg)](https://starchart.cc/kreuzwerker/terraform-provider-docker)
4 changes: 3 additions & 1 deletion docs/data-sources/registry_multiarch_image.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: |-

# docker_registry_multiarch_image (Data Source)

Reads the image metadata for each manifest in a [Docker multi-arch image](https://docs.docker.com/build/building/multi-platform/) from a Docker Registry.
Reads the image metadata for each manifest in a Docker multi-arch image from a Docker Registry.

## Example Usage

Expand Down Expand Up @@ -44,3 +44,5 @@ Read-Only:
- `media_type` (String)
- `os` (String)
- `sha256_digest` (String)


4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ terraform {
required_providers {
docker = {
source = "kreuzwerker/docker"
version = "3.0.2"
version = "3.1.0"
}
}
}
Expand All @@ -50,7 +50,7 @@ Terraform 0.12 and earlier:

```terraform
provider "docker" {
version = "~> 3.0.2"
version = "~> 3.1.0"
host = "unix:///var/run/docker.sock"
}
Expand Down
2 changes: 1 addition & 1 deletion examples/provider/provider-tf12.tf
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
provider "docker" {
version = "~> 3.0.2"
version = "~> 3.1.0"
host = "unix:///var/run/docker.sock"
}

Expand Down
2 changes: 1 addition & 1 deletion examples/provider/provider-tf13.tf
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ terraform {
required_providers {
docker = {
source = "kreuzwerker/docker"
version = "3.0.2"
version = "3.1.0"
}
}
}
Expand Down

0 comments on commit c139056

Please sign in to comment.