Skip to content

Commit

Permalink
docs: remove dius/pact_broker-docker image docs
Browse files Browse the repository at this point in the history
now deprecated
  • Loading branch information
YOU54F committed Sep 27, 2024
1 parent aa96c8a commit f5a2b2d
Show file tree
Hide file tree
Showing 11 changed files with 7 additions and 221 deletions.
6 changes: 0 additions & 6 deletions .github/workflows/sync-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ on:
- pact-rust-docs-updated
- pact-cpp-docs-updated
- pact-broker-docker-pactfoundation-docs-updated
- pact-broker-docker-dius-docs-updated
- pact-broker-helm-chart-docs-updated
- pact-broker-client-docs-updated
- pact-net-docs-updated
Expand All @@ -32,7 +31,6 @@ on:
- pact-rust-docs-updated
- pact-cpp-docs-updated
- pact-broker-docker-pactfoundation-docs-updated
- pact-broker-docker-dius-docs-updated
- pact-broker-helm-chart-docs-updated
- pact-broker-client-docs-updated
- pact-net-docs-updated
Expand Down Expand Up @@ -92,10 +90,6 @@ jobs:
run: bundle exec scripts/sync/pact_broker_docker_pactfoundation.rb && echo 'COMMIT_MESSAGE=synced pactfoundation/pact-broker docker image docs' >> $GITHUB_ENV
if: steps.identify_event.outputs.update_event == 'pact-broker-docker-pactfoundation-docs-updated'

- name: Sync dius/pact-broker Docker image docs
run: bundle exec scripts/sync/pact_broker_docker_dius.rb && echo 'COMMIT_MESSAGE=synced dius/pact-broker docker image docs' >> $GITHUB_ENV
if: steps.identify_event.outputs.update_event == 'pact-broker-docker-dius-docs-updated'

- name: Sync Pact Broker Helm Chart docs
run: bundle exec scripts/sync/pact_broker_helm_chart.rb && echo 'COMMIT_MESSAGE=synced pact-broker Helm Chart docs' >> $GITHUB_ENV
if: steps.identify_event.outputs.update_event == 'pact-broker-helm-chart-docs-updated'
Expand Down
18 changes: 0 additions & 18 deletions scripts/sync/pact_broker_docker_dius.rb

This file was deleted.

2 changes: 1 addition & 1 deletion scripts/sync/pact_jvm.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env ruby
require_relative 'support'

SOURCE_REPO = 'DiUS/pact-jvm'
SOURCE_REPO = 'pact-foundation/pact-jvm'
DESTINATION_DIR = relative_path_to('docs/implementation_guides/jvm')
TRANSFORM_PATH = -> (path) {
# Rename README.md file, but not the top level README
Expand Down
2 changes: 1 addition & 1 deletion website/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ When Pact reads the pact files for verification on the Provider side, it needs t
**Here are some options**

* Create a Mock authentication service used during testing - this gives you the best control.
* If using the JVM, you can use [request filters](https://github.com/DiUS/pact-jvm/tree/master/pact-jvm-provider-gradle#modifying-the-requests-before-they-are-sent) to modify the request headers before they are sent to the Provider.
* If using the JVM, you can use [request filters](https://github.com/pact-foundation/pact-jvm/tree/master/pact-jvm-provider-gradle#modifying-the-requests-before-they-are-sent) to modify the request headers before they are sent to the Provider.
* If using Pact JS you can use [request filters](https://github.com/pact-foundation/pact-js#modify-requests-prior-to-verification-request-filters)
* If using Pact Go you can use [request filters](https://github.com/pact-foundation/pact-go#request-filtering)
* Configure a relaxed OAuth2 validation service on the Provider that accepts any valid headers, so long as the match the spec \(e.g. `Authorization` header\). You might leverage the [provider states](http://docs.pact.io/getting_started/provider_states) feature for this.
Expand Down
2 changes: 1 addition & 1 deletion website/docs/getting_started/further_reading.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Hear how Soundcloud ["Move Fast and Consumer-Driven-Contract-Testing Things"](ht
## Implementations

* [Ruby Pact](https://github.com/pact-foundation/pact-ruby)
* [JVM Pact](https://github.com/DiUS/pact-jvm) and [Scala-Pact](https://github.com/ITV/scala-pact)
* [JVM Pact](https://github.com/pact-foundation/pact-jvm) and [Scala-Pact](https://github.com/ITV/scala-pact)
* [.NET Pact](https://github.com/SEEK-Jobs/pact-net)
* [JS Pact](https://github.com/pact-foundation/pact-js)
* [Go Pact](https://github.com/pact-foundation/pact-go)
Expand Down
2 changes: 1 addition & 1 deletion website/docs/implementation_guides/jvm.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Overview
---

[Pact JVM](https://github.com/DiUS/pact-jvm) is currently compliant to Pact Specification Version [3.0](https://github.com/pact-foundation/pact-specification/tree/version-3).
[Pact JVM](https://github.com/pact-foundation/pact-jvm) is currently compliant to Pact Specification Version [4.0](https://github.com/pact-foundation/pact-specification/tree/version-4).

Head to the [README](jvm/readme) to get started with Pact on the JVM \(Java, Scala, Clojure etc.\).

Expand Down
6 changes: 0 additions & 6 deletions website/docs/pact_broker/administration/maintenance.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,3 @@ If you have a very large database, and you are just now enabling the clean, the
#### pactfoundation/pact-broker Docker image

See the [environment variable documentation here](/pact_broker/docker_images/pactfoundation#automatic-data-clean-up)

#### dius/pact-broker Docker image

Not released yet.


2 changes: 1 addition & 1 deletion website/docs/pact_broker/advanced_topics/using-tls.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ bTk5fOGqTBqgzp1BgJKIKhI9CIUeAUYwggCWOeZnq4dpMkXH1xbsk4MMSOTimWbe

You'll need to configure the certificate both your development environment and your CI. It's a bit of a hassle, so again, do consider a CA signed certificate from [Let's Encrypt](https://letsencrypt.org) instead.

You can use this [Docker Compose](https://github.com/DiUS/pact_broker-docker/blob/master/docker-compose.yml) file to spike and troubleshoot connecting to a broker with a self signed certificate. Once you have run `docker-compose up` once and seen it work with the built in files, replace the certificate and key files with your own and run `docker-compose down` and `docker-compose up`.
You can use this [Docker Compose](https://github.com/pact-foundation/pact-broker-docker/blob/master/docker-compose.yml) file to spike and troubleshoot connecting to a broker with a self signed certificate. Once you have run `docker-compose up` once and seen it work with the built in files, replace the certificate and key files with your own and run `docker-compose down` and `docker-compose up`.

##### Extracting a copy of the certificate from a running Pact Broker

Expand Down
25 changes: 1 addition & 24 deletions website/docs/pact_broker/docker_images.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,35 +5,12 @@ sidebar_label: Overview

The Pact Broker is an application for sharing for Pact contracts and verification results, and is required for integrating Pact into CI/CD pipelines.

There are currently two supported Docker images: one which based on [Alpine, running on Puma](/pact_broker/docker_images/pactfoundation), and one which is based on [Ubuntu, running Phusion Passenger](/pact_broker/docker_images/dius). See [Which Docker image should I use?](#which-docker-image-should-i-use) for a comparison.
There is currently one supported Docker image based on [Alpine, running on Puma](/pact_broker/docker_images/pactfoundation).

While there are [high level instructions][rollyourown] provided for running the application outside of Docker, we cannot provide support for these installations, as there are too many variables.

## In a hurry?

If you want to try out a Pact Broker that can be accessed by all your teams, without having to fill in infrastructure requisition forms and wait for 3 months, you can get a free trial at <a href="https://pactflow.io/?utm_source=github&utm_campaign=dockerized_pact_broker_index">pactflow.io</a>. Built by a group of core Pact maintainers, PactFlow is a fork of the OSS Pact Broker with extra goodies like an improved UI, field level verification results, and user and teams management. It's also fully supported, and that means when something goes wrong, *someone else* gets woken up in the middle of the afternoon to fix it...


## Which Docker image should I use?

The `pactfoundation` image:

* Uses Puma on Alpine
* Is smaller
* Does not require root to run (and hence, can only run on ports above 1024)
* Will not restart itself if it crashes
* Is more suited to being run by a Docker container orchestration service (ECS, Fargate, Kubernetes etc.)

The `dius` image:

* Uses Passenger on Ubuntu
* Is bigger
* Requires root to run (and hence, can run on ports under 1024)
* Will restart the child processes if they crash.

Please read https://github.com/phusion/passenger/wiki/Puma-vs-Phusion-Passenger for information on which server will suit your needs best. The tl;dr is that if you want to run the docker image in a managed architecture which will make your application highly available (eg. ECS, Kubernetes) then use the Puma based `pactfoundation/pact-broker`. Puma will not restart itself if it crashes, so you will need external monitoring to ensure the Pact Broker stays available.

If you want to run the container as a standalone instance, then the `dius/pact-broker` image which uses Phusion Passenger may serve you better, as Passenger will restart any crashed processes.


[rollyourown]: https://github.com/pact-foundation/pact_broker#rolling-your-own
161 changes: 0 additions & 161 deletions website/docs/pact_broker/docker_images/dius.md

This file was deleted.

Loading

0 comments on commit f5a2b2d

Please sign in to comment.