Skip to content

Commit

Permalink
Transition from mailgun org to gubernator-io org
Browse files Browse the repository at this point in the history
  • Loading branch information
thrawn01 committed Jan 24, 2024
1 parent 885519d commit 66a86f1
Show file tree
Hide file tree
Showing 39 changed files with 251 additions and 68 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/on-release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ jobs:
uses: docker/build-push-action@v3
with:
tags: |
ghcr.io/mailgun/gubernator:${{ github.event.release.tag_name }}
ghcr.io/mailgun/gubernator:latest
ghcr.io/gubernator-io/gubernator:${{ github.event.release.tag_name }}
ghcr.io/gubernator-io/gubernator:latest
build-args: |
VERSION=${{ github.event.release.tag_name }}
platforms: linux/amd64,linux/arm64
Expand Down
135 changes: 135 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@
## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official email address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[INSERT CONTACT METHOD].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

## Report Violations
Please contact one of the maintainers or @thrawn01 if you wish to report a
violation of this code of conduct or if you have a question about the adoption
of this code of conduct.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Contributing

Thanks for your interest in contributing to Gubernator! Please take a moment to review this document **before submitting a pull request**.

## Pull requests

**Please ask first before starting work on any significant new features.**

We love to code, and as such, we tend to code first and talk later. (wut? I haz to talk with people?) However, it's
never a fun experience to have your pull request declined after investing joy, time and effort into a new feature.

To avoid this from happening to you, we request that contributors create a GitHub issue and tag a maintainer, so we
can first discuss any new feature ideas. Your ideas and suggestions are welcome!

Bug requests are always welcome, but if the bug request requires a large refactor to fix, you might want to create
and issue and discuss.

### Fork and create a branch
If this is something you think you can fix, then fork https://github.com/gubernator-io/gubernator and create
a branch with a descriptive name.

### Run tests
You can run the test suite with all the bells and whistles by running
```bash
$ make test
```
### Run linter
We use a linter to ensure things stay pretty, ensure your code passes the linter by running
```bash
$ make lint
```

### Commits & Messages
We don't have a specific structure for commit messages, but please be as descriptive as possible and avoid
lots of tiny commits. If this is your style, please squash before making a PR, or we may squash on merge.

### Create a Pull Request
At this point, your changes look good, and tests are passing, you are ready to create a pull request. Please
explain WHY the PR exists in the description, and link to any related PR's or Issues.

## Merging a PR (maintainers only)
A PR can only be merged into master by a maintainer if: CI is passing, approved by another maintainer and is
up-to-date with the default branch. Any maintainer is allowed to merge a PR if all of these conditions ae met.

## Shipping a release (maintainers only)
See [RELEASE.md](docs/RELEASE.md) for detailed procedures



10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ bench:

.PHONY: docker
docker:
docker build --build-arg VERSION=$(VERSION) -t ghcr.io/mailgun/gubernator:$(VERSION) .
docker tag ghcr.io/mailgun/gubernator:$(VERSION) ghcr.io/mailgun/gubernator:latest
docker build --build-arg VERSION=$(VERSION) -t ghcr.io/gubernator-io/gubernator:$(VERSION) .
docker tag ghcr.io/gubernator-io/gubernator:$(VERSION) ghcr.io/gubernator-io/gubernator:latest

.PHONY: release
release:
Expand All @@ -43,16 +43,16 @@ proto:
certs:
rm certs/*.key || rm certs/*.srl || rm certs/*.csr || rm certs/*.pem || rm certs/*.cert || true
openssl genrsa -out certs/ca.key 4096
openssl req -new -x509 -key certs/ca.key -sha256 -subj "/C=US/ST=TX/O=Mailgun Technologies, Inc." -days 3650 -out certs/ca.cert
openssl req -new -x509 -key certs/ca.key -sha256 -subj "/C=US/ST=TX/O=Gubernator Opensource" -days 3650 -out certs/ca.cert
openssl genrsa -out certs/gubernator.key 4096
openssl req -new -key certs/gubernator.key -out certs/gubernator.csr -config certs/gubernator.conf
openssl x509 -req -in certs/gubernator.csr -CA certs/ca.cert -CAkey certs/ca.key -set_serial 1 -out certs/gubernator.pem -days 3650 -sha256 -extfile certs/gubernator.conf -extensions req_ext
openssl genrsa -out certs/gubernator_no_ip_san.key 4096
openssl req -new -key certs/gubernator_no_ip_san.key -out certs/gubernator_no_ip_san.csr -config certs/gubernator_no_ip_san.conf
openssl x509 -req -in certs/gubernator_no_ip_san.csr -CA certs/ca.cert -CAkey certs/ca.key -set_serial 2 -out certs/gubernator_no_ip_san.pem -days 3650 -sha256 -extfile certs/gubernator_no_ip_san.conf -extensions req_ext
# Client Auth
openssl req -new -x509 -days 3650 -keyout certs/client-auth-ca.key -out certs/client-auth-ca.pem -subj "/C=TX/ST=TX/O=Mailgun Technologies, Inc./CN=mailgun.com/emailAddress=admin@mailgun.com" -passout pass:test
openssl req -new -x509 -days 3650 -keyout certs/client-auth-ca.key -out certs/client-auth-ca.pem -subj "/C=TX/ST=TX/O=Gubernator Opensource/CN=gubernator.io/emailAddress=admin@gubernator.io" -passout pass:test
openssl genrsa -out certs/client-auth.key 2048
openssl req -sha1 -key certs/client-auth.key -new -out certs/client-auth.req -subj "/C=US/ST=TX/O=Mailgun Technologies, Inc./CN=client.com/emailAddress=admin@mailgun.com"
openssl req -sha1 -key certs/client-auth.key -new -out certs/client-auth.req -subj "/C=US/ST=TX/O=Gubernator Opensource/CN=client.com/emailAddress=admin@gubernator.io"
openssl x509 -req -days 3650 -in certs/client-auth.req -CA certs/client-auth-ca.pem -CAkey certs/client-auth-ca.key -set_serial 3 -passin pass:test -out certs/client-auth.pem
openssl x509 -extfile certs/client-auth.conf -extensions ssl_client -req -days 3650 -in certs/client-auth.req -CA certs/client-auth-ca.pem -CAkey certs/client-auth-ca.key -set_serial 4 -passin pass:test -out certs/client-auth.pem
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ rate limit config is made up of only 4, 64bit integers.
### Quick Start
```bash
# Download the docker-compose file
$ curl -O https://raw.githubusercontent.com/mailgun/gubernator/master/docker-compose.yaml
$ curl -O https://raw.githubusercontent.com/gubernator-io/gubernator/master/docker-compose.yaml
# Run the docker container
$ docker-compose up -d
```
Expand Down Expand Up @@ -306,7 +306,7 @@ $ curl http://localhost:9080/v1/HealthCheck
##### Kubernetes
```bash
# Download the kubernetes deployment spec
$ curl -O https://raw.githubusercontent.com/mailgun/gubernator/master/k8s-deployment.yaml
$ curl -O https://raw.githubusercontent.com/gubernator-io/gubernator/master/k8s-deployment.yaml

# Edit the deployment file to change the environment config variables
$ vi k8s-deployment.yaml
Expand Down
2 changes: 1 addition & 1 deletion benchmark_cache_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"testing"
"time"

gubernator "github.com/mailgun/gubernator/v2"
"github.com/gubernator-io/gubernator/v2"
"github.com/mailgun/holster/v4/clock"
)

Expand Down
4 changes: 2 additions & 2 deletions benchmark_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ import (
"context"
"testing"

guber "github.com/mailgun/gubernator/v2"
"github.com/mailgun/gubernator/v2/cluster"
guber "github.com/gubernator-io/gubernator/v2"
"github.com/gubernator-io/gubernator/v2/cluster"
"github.com/mailgun/holster/v4/syncutil"
"github.com/stretchr/testify/require"
)
Expand Down
2 changes: 1 addition & 1 deletion cluster/cluster.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import (
"fmt"
"math/rand"

gubernator "github.com/mailgun/gubernator/v2"
"github.com/gubernator-io/gubernator/v2"
"github.com/mailgun/holster/v4/clock"
"github.com/mailgun/holster/v4/errors"
"github.com/sirupsen/logrus"
Expand Down
4 changes: 2 additions & 2 deletions cluster/cluster_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ package cluster_test
import (
"testing"

gubernator "github.com/mailgun/gubernator/v2"
"github.com/mailgun/gubernator/v2/cluster"
gubernator "github.com/gubernator-io/gubernator/v2"
"github.com/gubernator-io/gubernator/v2/cluster"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
Expand Down
4 changes: 2 additions & 2 deletions cmd/gubernator-cli/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ import (
"time"

"github.com/davecgh/go-spew/spew"
guber "github.com/mailgun/gubernator/v2"
guber "github.com/gubernator-io/gubernator/v2"
"github.com/mailgun/holster/v4/clock"
"github.com/mailgun/holster/v4/errors"
"github.com/mailgun/holster/v4/setter"
Expand Down Expand Up @@ -70,7 +70,7 @@ func main() {
}
ctx := context.Background()
err = tracing.InitTracing(ctx,
"github.com/mailgun/gubernator/v2/cmd/gubernator-cli",
"github.com/gubernator-io/gubernator/v2/cmd/gubernator-cli",
tracing.WithResource(res),
)
if err != nil {
Expand Down
4 changes: 2 additions & 2 deletions cmd/gubernator-cluster/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@ import (
"os"
"os/signal"

gubernator "github.com/mailgun/gubernator/v2"
"github.com/mailgun/gubernator/v2/cluster"
"github.com/gubernator-io/gubernator/v2"
"github.com/gubernator-io/gubernator/v2/cluster"
"github.com/sirupsen/logrus"
)

Expand Down
4 changes: 2 additions & 2 deletions cmd/gubernator/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ import (
"runtime"
"syscall"

gubernator "github.com/mailgun/gubernator/v2"
"github.com/gubernator-io/gubernator/v2"
"github.com/mailgun/holster/v4/clock"
"github.com/mailgun/holster/v4/tracing"
"github.com/sirupsen/logrus"
Expand Down Expand Up @@ -65,7 +65,7 @@ func main() {
// Initialize tracing.
ctx := context.Background()
err = tracing.InitTracing(ctx,
"github.com/mailgun/gubernator/v2",
"github.com/gubernator-io/gubernator/v2",
tracing.WithLevel(gubernator.GetTracingLevel()),
tracing.WithResource(res),
)
Expand Down
2 changes: 1 addition & 1 deletion cmd/healthcheck/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ import (
"net/http"
"os"

guber "github.com/mailgun/gubernator/v2"
guber "github.com/gubernator-io/gubernator/v2"
)

func main() {
Expand Down
16 changes: 8 additions & 8 deletions contrib/aws-ecs-service-discovery-deployment/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,15 @@ Real gubernator would be accessible in `app.gubernator.example.com`

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| Name | Description | Type | Default | Required |
|------|--------------------------------------------------------------------------------------------------------------------|------|---------|:--------:|
| <a name="input_dns_namespace"></a> [dns\_namespace](#input\_dns\_namespace) | The domain name the service should run. Your Gubernator instances will be available at `app.<your inputted fqdn>.` | `string` | n/a | yes |
| <a name="input_gubernator_config"></a> [gubernator\_config](#input\_gubernator\_config) | Map of ECS Configuration for gubernator service. map(cpu, memory) | `any` | <pre>{<br> "cpu": 256,<br> "memory": 512<br>}</pre> | no |
| <a name="input_gubernator_debug_mode"></a> [gubernator\_debug\_mode](#input\_gubernator\_debug\_mode) | Enable GUBER\_DEBUG env flag | `bool` | `false` | no |
| <a name="input_gubernator_repository"></a> [gubernator\_repository](#input\_gubernator\_repository) | Gubernator Docker Repository. e.g. ghcr.io/mailgun/gubernator | `string` | n/a | yes |
| <a name="input_gubernator_version"></a> [gubernator\_version](#input\_gubernator\_version) | Gubernator docker tag to use | `string` | n/a | yes |
| <a name="input_prefix"></a> [prefix](#input\_prefix) | Prefix of created resources | `string` | n/a | yes |
| <a name="input_vpc_cidr"></a> [vpc\_cidr](#input\_vpc\_cidr) | IPv4 CIDR Notation for VPC IP range. e.g. 10.3.0.0/16 | `string` | n/a | yes |
| <a name="input_gubernator_config"></a> [gubernator\_config](#input\_gubernator\_config) | Map of ECS Configuration for gubernator service. map(cpu, memory) | `any` | <pre>{<br> "cpu": 256,<br> "memory": 512<br>}</pre> | no |
| <a name="input_gubernator_debug_mode"></a> [gubernator\_debug\_mode](#input\_gubernator\_debug\_mode) | Enable GUBER\_DEBUG env flag | `bool` | `false` | no |
| <a name="input_gubernator_repository"></a> [gubernator\_repository](#input\_gubernator\_repository) | Gubernator Docker Repository. e.g. ghcr.io/gubernator-io/gubernator | `string` | n/a | yes |
| <a name="input_gubernator_version"></a> [gubernator\_version](#input\_gubernator\_version) | Gubernator docker tag to use | `string` | n/a | yes |
| <a name="input_prefix"></a> [prefix](#input\_prefix) | Prefix of created resources | `string` | n/a | yes |
| <a name="input_vpc_cidr"></a> [vpc\_cidr](#input\_vpc\_cidr) | IPv4 CIDR Notation for VPC IP range. e.g. 10.3.0.0/16 | `string` | n/a | yes |

## Outputs

Expand Down
2 changes: 1 addition & 1 deletion contrib/aws-ecs-service-discovery-deployment/variables.tf
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ variable "dns_namespace" {

variable "gubernator_repository" {
type = string
description = "Gubernator Docker Repository. e.g. ghcr.io/mailgun/gubernator"
description = "Gubernator Docker Repository. e.g. ghcr.io/gubernator-io/gubernator"
}

variable "gubernator_version" {
Expand Down
2 changes: 1 addition & 1 deletion contrib/certs/gubernator.conf
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ distinguished_name = dn
[dn]
C = US
ST = TX
O = Mailgun Technologies, Inc.
O = Gubernator Opensource
CN = localhost
[req_ext]
subjectAltName = @alt_names
Expand Down
2 changes: 1 addition & 1 deletion contrib/certs/gubernator_no_ip_san.conf
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ distinguished_name = dn
[dn]
C = US
ST = TX
O = Mailgun Technologies, Inc.
O = Gubernator Opensource
CN = localhost
[req_ext]
subjectAltName = @alt_names
Expand Down
Loading

0 comments on commit 66a86f1

Please sign in to comment.