From 4d741531b436e67f6bfbbb38d36ca302ea72ec10 Mon Sep 17 00:00:00 2001 From: Daniel Nephin Date: Tue, 29 Jun 2021 17:04:24 -0400 Subject: [PATCH] Update references to the main branch The main branch is being renamed from master->main. This commit should update all references to the main branch to the new name. Co-Authored-By: Mike Morris --- .circleci/config.yml | 30 ++++++++--------- .circleci/scripts/cherry-picker.sh | 2 +- .github/CONTRIBUTING.md | 2 +- .github/workflows/changelog-checker.yml | 4 +-- .github/workflows/load-test.yml | 6 ++-- .github/workflows/website-checker.yml | 4 +-- GNUmakefile | 2 +- README.md | 4 +-- build-support/functions/10-util.sh | 2 +- command/connect/envoy/bootstrap_config.go | 2 +- contributing/INTERNALS.md | 32 +++++++++---------- contributing/streaming/README.md | 12 +++---- .../content/api-docs/libraries-and-sdks.mdx | 2 +- .../observability/ui-visualization.mdx | 2 +- .../docs/connect/proxies/integrate.mdx | 2 +- website/content/docs/install/ports.mdx | 2 +- website/content/docs/k8s/upgrade/index.mdx | 2 +- website/content/docs/release-notes/1-9-0.mdx | 2 +- .../content/docs/security/acl/acl-legacy.mdx | 2 +- .../content/docs/security/acl/acl-rules.mdx | 2 +- .../docs/security/acl/auth-methods/oidc.mdx | 2 +- .../instructions/upgrade-to-1-2-x.mdx | 2 +- .../instructions/upgrade-to-1-6-x.mdx | 2 +- .../instructions/upgrade-to-1-8-x.mdx | 2 +- .../docs/upgrading/upgrade-specific.mdx | 6 ++-- website/pages/api-docs/[[...page]].jsx | 2 +- website/pages/commands/[[...page]].jsx | 2 +- website/pages/docs/[[...page]].jsx | 2 +- 28 files changed, 69 insertions(+), 69 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index e553a8bb86..0ec13bb412 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -60,7 +60,7 @@ steps: name: notify-slack-failure when: on_fail command: | - if [[ $CIRCLE_BRANCH == "master" ]]; then + if [[ $CIRCLE_BRANCH == "main" ]]; then CIRCLE_ENDPOINT="https://app.circleci.com/pipelines/github/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME}?branch=${CIRCLE_BRANCH}" GITHUB_ENDPOINT="https://github.com/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME}/commit/${CIRCLE_SHA1}" COMMIT_MESSAGE=$(git log -1 --pretty=%B | head -n1) @@ -79,7 +79,7 @@ steps: ] \ }" "${FEED_CONSUL_GH_URL}" else - echo "Not posting slack failure notifications for non-master branch" + echo "Not posting slack failure notifications for non-main branch" fi commands: @@ -386,7 +386,7 @@ jobs: <<: *ENVIRONMENT steps: - checkout - - attach_workspace: # this normally runs as the first job and has nothing to attach; only used in master branch after rebuilding UI + - attach_workspace: # this normally runs as the first job and has nothing to attach; only used in main branch after rebuilding UI at: . - run: command: make dev @@ -486,7 +486,7 @@ jobs: path: *TEST_RESULTS_DIR - run: *notify-slack-failure - # run integration tests on nomad/master + # run integration tests on nomad/main nomad-integration-main: docker: - image: *GOLANG_IMAGE @@ -648,7 +648,7 @@ jobs: short_sha=$(git rev-parse --short HEAD) git add agent/uiserver/bindata_assetfs.go git commit -m "auto-updated agent/uiserver/bindata_assetfs.go from commit ${short_sha}" - git push origin master + git push origin main else echo "no UI changes so no static assets to publish" fi @@ -833,7 +833,7 @@ jobs: path: *TEST_RESULTS_DIR - run: *notify-slack-failure - # only runs on master: checks latest commit to see if the PR associated has a backport/* or docs* label to cherry-pick + # only runs on main: checks latest commit to see if the PR associated has a backport/* or docs* label to cherry-pick cherry-picker: docker: - image: docker.mirror.hashicorp.services/alpine:3.12 @@ -993,12 +993,12 @@ workflows: - check-vendor - build-amd64: *require-check-vendor - build-arm: *require-check-vendor - # every commit on master will have a rebuilt UI + # every commit on main will have a rebuilt UI - frontend-cache: filters: branches: only: - - master + - main - ember-build-prod: requires: - frontend-cache @@ -1009,7 +1009,7 @@ workflows: filters: branches: only: - - master + - main - /release\/\d+\.\d+\.x$/ requires: - build-static-assets @@ -1034,7 +1034,7 @@ workflows: branches: ignore: - /^pull\/.*$/ # only push dev builds from non forks - - master # all master dev uploads will include a UI rebuild in build-distros + - main # all main dev uploads will include a UI rebuild in build-distros - dev-upload-docker: <<: *dev-upload context: consul-ci @@ -1071,7 +1071,7 @@ workflows: filters: branches: only: - - master + - main - algolia-index: context: consul-docs filters: @@ -1085,7 +1085,7 @@ workflows: filters: branches: only: - - master + - main - /^ui\/.*/ - workspace-tests: requires: @@ -1118,14 +1118,14 @@ workflows: filters: branches: only: - - master + - main - /release\/\d+\.\d+\.x$/ - cherry-picker: context: team-consul filters: branches: only: - - master + - main - /release\/\d+\.\d+\.x$/ load-test: when: << pipeline.parameters.trigger-load-test >> @@ -1139,6 +1139,6 @@ workflows: filters: branches: only: - - master + - main jobs: - load-test diff --git a/.circleci/scripts/cherry-picker.sh b/.circleci/scripts/cherry-picker.sh index 8a997ac453..a217e4a2bb 100755 --- a/.circleci/scripts/cherry-picker.sh +++ b/.circleci/scripts/cherry-picker.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash # -# This script is meant to run on every new commit to master in CircleCI. If the commit comes from a PR, it will +# This script is meant to run on every new commit to main in CircleCI. If the commit comes from a PR, it will # check the PR associated with the commit for labels. If the label matches `docs*` it will be cherry-picked # to stable-website. If the label matches `backport/*`, it will be cherry-picked to the appropriate `release/*` # branch. diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d3d98f8d3f..8cc9ef6644 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -60,7 +60,7 @@ issue. Stale issues will be closed. ## Building Consul If you wish to work on Consul itself, you'll first need [Go](https://golang.org) -installed (The version of Go should match the one of our [CI config's](https://github.com/hashicorp/consul/blob/master/.circleci/config.yml) Go image). +installed (The version of Go should match the one of our [CI config's](https://github.com/hashicorp/consul/blob/main/.circleci/config.yml) Go image). Next, clone this repository and then run `make dev`. In a few moments, you'll have a working diff --git a/.github/workflows/changelog-checker.yml b/.github/workflows/changelog-checker.yml index 16703030ab..abeee801b6 100644 --- a/.github/workflows/changelog-checker.yml +++ b/.github/workflows/changelog-checker.yml @@ -4,9 +4,9 @@ on: pull_request: types: [opened, synchronize, labeled] - # Runs on PRs to master and all release branches + # Runs on PRs to main and all release branches branches: - - master + - main - release/* jobs: diff --git a/.github/workflows/load-test.yml b/.github/workflows/load-test.yml index 9c6a113862..b603bf7e6c 100644 --- a/.github/workflows/load-test.yml +++ b/.github/workflows/load-test.yml @@ -1,7 +1,7 @@ on: pull_request: branches: - - master + - main types: [labeled] jobs: @@ -16,9 +16,9 @@ jobs: - name: Trigger CircleCI Load Test Pipeline run: | # build json payload to trigger CircleCI Load Test Pipeline - # This only runs the load test pipeline on the 'master' branch + # This only runs the load test pipeline on the 'main' branch jsonData=$(jq --null-input -r --arg commit ${{ github.event.pull_request.head.sha }} \ - '{branch:"master", parameters: {"commit": $commit, "trigger-load-test": true}}') + '{branch:"main", parameters: {"commit": $commit, "trigger-load-test": true}}') echo "Passing JSON data to CircleCI API: $jsonData" load_test_pipeline_id=$(curl -X POST \ -H "Circle-Token: ${{ secrets.CIRCLE_TOKEN }}" \ diff --git a/.github/workflows/website-checker.yml b/.github/workflows/website-checker.yml index cde5031f0d..505e7626bb 100644 --- a/.github/workflows/website-checker.yml +++ b/.github/workflows/website-checker.yml @@ -13,9 +13,9 @@ on: pull_request_target: types: [opened] - # Runs on PRs to master and all release branches + # Runs on PRs to main and all release branches branches: - - master + - main - release/* jobs: diff --git a/GNUmakefile b/GNUmakefile index 7e714b24e0..891996b0fb 100644 --- a/GNUmakefile +++ b/GNUmakefile @@ -176,7 +176,7 @@ ci.dev-docker: @echo $(DOCKER_PASS) | docker login -u="$(DOCKER_USER)" --password-stdin @echo "Pushing dev image to: https://cloud.docker.com/u/hashicorpdev/repository/docker/hashicorpdev/consul" @docker push $(CI_DEV_DOCKER_NAMESPACE)/$(CI_DEV_DOCKER_IMAGE_NAME):$(GIT_COMMIT) -ifeq ($(CIRCLE_BRANCH), master) +ifeq ($(CIRCLE_BRANCH), main) @docker tag $(CI_DEV_DOCKER_NAMESPACE)/$(CI_DEV_DOCKER_IMAGE_NAME):$(GIT_COMMIT) $(CI_DEV_DOCKER_NAMESPACE)/$(CI_DEV_DOCKER_IMAGE_NAME):latest @docker push $(CI_DEV_DOCKER_NAMESPACE)/$(CI_DEV_DOCKER_IMAGE_NAME):latest endif diff --git a/README.md b/README.md index d70061d541..2643901b8c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Consul [![CircleCI](https://circleci.com/gh/hashicorp/consul/tree/master.svg?style=svg)](https://circleci.com/gh/hashicorp/consul/tree/master) [![Discuss](https://img.shields.io/badge/discuss-consul-ca2171.svg?style=flat)](https://discuss.hashicorp.com/c/consul) +# Consul [![CircleCI](https://circleci.com/gh/hashicorp/consul/tree/main.svg?style=svg)](https://circleci.com/gh/hashicorp/consul/tree/main) [![Discuss](https://img.shields.io/badge/discuss-consul-ca2171.svg?style=flat)](https://discuss.hashicorp.com/c/consul) * Website: https://www.consul.io * Tutorials: [HashiCorp Learn](https://learn.hashicorp.com/consul) @@ -54,4 +54,4 @@ https://www.consul.io/docs ## Contributing -Thank you for your interest in contributing! Please refer to [CONTRIBUTING.md](https://github.com/hashicorp/consul/blob/master/.github/CONTRIBUTING.md) for guidance. +Thank you for your interest in contributing! Please refer to [CONTRIBUTING.md](https://github.com/hashicorp/consul/blob/main/.github/CONTRIBUTING.md) for guidance. diff --git a/build-support/functions/10-util.sh b/build-support/functions/10-util.sh index 59e714d536..9198e3bf14 100644 --- a/build-support/functions/10-util.sh +++ b/build-support/functions/10-util.sh @@ -555,7 +555,7 @@ function git_push_ref { local upstream=$(git_upstream "${sdir}") || return 1 # upstream branch for this branch does not track the remote we need to push to - # basically this checks that the upstream (could be something like origin/master) references the correct remote + # basically this checks that the upstream (could be something like origin/main) references the correct remote # if it doesn't then the string modification wont apply and the var will reamin unchanged and equal to itself. if test "${upstream#${remote}/}" == "${upstream}" then diff --git a/command/connect/envoy/bootstrap_config.go b/command/connect/envoy/bootstrap_config.go index 12a623b22b..b78f816677 100644 --- a/command/connect/envoy/bootstrap_config.go +++ b/command/connect/envoy/bootstrap_config.go @@ -86,7 +86,7 @@ type BootstrapConfig struct { // configure the aspects that Connect relies upon to work. It's recommended // that this only be used if necessary, and that it be based on the default // template in - // https://github.com/hashicorp/consul/blob/master/command/connect/envoy/bootstrap_tpl.go + // https://github.com/hashicorp/consul/blob/main/command/connect/envoy/bootstrap_tpl.go // for the correct version of Consul and Envoy being used. OverrideJSONTpl string `mapstructure:"envoy_bootstrap_json_tpl"` diff --git a/contributing/INTERNALS.md b/contributing/INTERNALS.md index 38fd01aaf2..6d62913450 100644 --- a/contributing/INTERNALS.md +++ b/contributing/INTERNALS.md @@ -22,13 +22,13 @@ The components in this section are shared between Consul agents in client and se | Directory | Contents | | --------- | -------- | -| [command/agent](https://github.com/hashicorp/consul/tree/master/command/agent) | This contains the actual CLI command implementation for the `consul agent` command, which mostly just invokes an agent object from the `agent` package. | -| [agent](https://github.com/hashicorp/consul/tree/master/agent) | This is where the agent object is defined, and the top level `agent` package has all of the functionality that's common to both client and server agents. This includes things like service registration, the HTTP and DNS endpoints, watches, and top-level glue for health checks. | -| [agent/config](https://github.com/hashicorp/consul/tree/master/agent/config) | This has all the user-facing [configuration](https://www.consul.io/docs/agent/options.html) processing code, as well as the internal configuration structure that's used by the agent. | -| [agent/checks](https://github.com/hashicorp/consul/tree/master/agent/checks) | This has implementations for the different [health check types](https://www.consul.io/docs/agent/checks.html). | -| [agent/ae](https://github.com/hashicorp/consul/tree/master/agent/ae), [agent/local](https://github.com/hashicorp/consul/tree/master/agent/local) | These are used together to power the agent's [Anti-Entropy Sync Back](https://www.consul.io/docs/internals/anti-entropy.html) process to the Consul servers. | -| [agent/router](https://github.com/hashicorp/consul/tree/master/agent/router), [agent/pool](https://github.com/hashicorp/consul/tree/master/agent/pool) | These are used for routing RPC queries to Consul servers and for connection pooling. | -| [agent/structs](https://github.com/hashicorp/consul/tree/master/agent/structs) | This has definitions of all the internal RPC protocol request and response structures. | +| [command/agent](https://github.com/hashicorp/consul/tree/main/command/agent) | This contains the actual CLI command implementation for the `consul agent` command, which mostly just invokes an agent object from the `agent` package. | +| [agent](https://github.com/hashicorp/consul/tree/main/agent) | This is where the agent object is defined, and the top level `agent` package has all of the functionality that's common to both client and server agents. This includes things like service registration, the HTTP and DNS endpoints, watches, and top-level glue for health checks. | +| [agent/config](https://github.com/hashicorp/consul/tree/main/agent/config) | This has all the user-facing [configuration](https://www.consul.io/docs/agent/options.html) processing code, as well as the internal configuration structure that's used by the agent. | +| [agent/checks](https://github.com/hashicorp/consul/tree/main/agent/checks) | This has implementations for the different [health check types](https://www.consul.io/docs/agent/checks.html). | +| [agent/ae](https://github.com/hashicorp/consul/tree/main/agent/ae), [agent/local](https://github.com/hashicorp/consul/tree/main/agent/local) | These are used together to power the agent's [Anti-Entropy Sync Back](https://www.consul.io/docs/internals/anti-entropy.html) process to the Consul servers. | +| [agent/router](https://github.com/hashicorp/consul/tree/main/agent/router), [agent/pool](https://github.com/hashicorp/consul/tree/main/agent/pool) | These are used for routing RPC queries to Consul servers and for connection pooling. | +| [agent/structs](https://github.com/hashicorp/consul/tree/main/agent/structs) | This has definitions of all the internal RPC protocol request and response structures. | ### Server Components @@ -36,9 +36,9 @@ The components in this section are only used by Consul servers. | Directory | Contents | | --------- | -------- | -| [agent/consul](https://github.com/hashicorp/consul/tree/master/agent/consul) | This is where the Consul server object is defined, and the top-level `consul` package has all of the functionality that's used by server agents. This includes things like the internal RPC endpoints. | -| [agent/consul/fsm](https://github.com/hashicorp/consul/tree/master/agent/consul/fsm), [agent/consul/state](https://github.com/hashicorp/consul/tree/master/agent/consul/state) | These components make up Consul's finite state machine (updated by the Raft consensus algorithm) and backed by the state store (based on immutable radix trees). All updates of Consul's consistent state is handled by the finite state machine, and all read queries to the Consul servers are serviced by the state store's data structures. | -| [agent/consul/autopilot](https://github.com/hashicorp/consul/tree/master/agent/consul/autopilot) | This contains a package of functions that provide Consul's [Autopilot](https://www.consul.io/docs/guides/autopilot.html) features. | +| [agent/consul](https://github.com/hashicorp/consul/tree/main/agent/consul) | This is where the Consul server object is defined, and the top-level `consul` package has all of the functionality that's used by server agents. This includes things like the internal RPC endpoints. | +| [agent/consul/fsm](https://github.com/hashicorp/consul/tree/main/agent/consul/fsm), [agent/consul/state](https://github.com/hashicorp/consul/tree/main/agent/consul/state) | These components make up Consul's finite state machine (updated by the Raft consensus algorithm) and backed by the state store (based on immutable radix trees). All updates of Consul's consistent state is handled by the finite state machine, and all read queries to the Consul servers are serviced by the state store's data structures. | +| [agent/consul/autopilot](https://github.com/hashicorp/consul/tree/main/agent/consul/autopilot) | This contains a package of functions that provide Consul's [Autopilot](https://www.consul.io/docs/guides/autopilot.html) features. | ### Other Components @@ -46,12 +46,12 @@ There are several other top-level packages used internally by Consul as well as | Directory | Contents | | --------- | -------- | -| [acl](https://github.com/hashicorp/consul/tree/master/api) | This supports the underlying policy engine for Consul's [ACL](https://www.consul.io/docs/guides/acl.html) system. | -| [api](https://github.com/hashicorp/consul/tree/master/api) | This `api` package provides an official Go API client for Consul, which is also used by Consul's [CLI](https://www.consul.io/docs/commands/index.html) commands to communicate with the local Consul agent. | -| [command](https://github.com/hashicorp/consul/tree/master/command) | This contains a sub-package for each of Consul's [CLI](https://www.consul.io/docs/commands/index.html) command implementations. | -| [snapshot](https://github.com/hashicorp/consul/tree/master/snapshot) | This has implementation details for Consul's [snapshot archives](https://www.consul.io/api/snapshot.html). | -| [api/watch](https://github.com/hashicorp/consul/tree/master/api/watch) | This has implementation details for Consul's [watches](https://www.consul.io/docs/agent/watches.html), used both internally to Consul and by the [watch CLI command](https://www.consul.io/docs/commands/watch.html). | -| [website](https://github.com/hashicorp/consul/tree/master/website) | This has the full source code for [consul.io](https://www.consul.io/). Pull requests can update the source code and Consul's documentation all together. | +| [acl](https://github.com/hashicorp/consul/tree/main/api) | This supports the underlying policy engine for Consul's [ACL](https://www.consul.io/docs/guides/acl.html) system. | +| [api](https://github.com/hashicorp/consul/tree/main/api) | This `api` package provides an official Go API client for Consul, which is also used by Consul's [CLI](https://www.consul.io/docs/commands/index.html) commands to communicate with the local Consul agent. | +| [command](https://github.com/hashicorp/consul/tree/main/command) | This contains a sub-package for each of Consul's [CLI](https://www.consul.io/docs/commands/index.html) command implementations. | +| [snapshot](https://github.com/hashicorp/consul/tree/main/snapshot) | This has implementation details for Consul's [snapshot archives](https://www.consul.io/api/snapshot.html). | +| [api/watch](https://github.com/hashicorp/consul/tree/main/api/watch) | This has implementation details for Consul's [watches](https://www.consul.io/docs/agent/watches.html), used both internally to Consul and by the [watch CLI command](https://www.consul.io/docs/commands/watch.html). | +| [website](https://github.com/hashicorp/consul/tree/main/website) | This has the full source code for [consul.io](https://www.consul.io/). Pull requests can update the source code and Consul's documentation all together. | ## FAQ diff --git a/contributing/streaming/README.md b/contributing/streaming/README.md index ef56bcc0ae..121b72851c 100644 --- a/contributing/streaming/README.md +++ b/contributing/streaming/README.md @@ -31,12 +31,12 @@ endpoint calls raft.Apply, which if successful will save the new data in the sta When the [state.Store commits] it produces an event which is managed by the [EventPublisher] and sent to any active subscriptions. -[rpcclient/health.Health]: https://github.com/hashicorp/consul/blob/master/agent/rpcclient/health/health.go -[StreamingHealthServices cache-type]: https://github.com/hashicorp/consul/blob/master/agent/cache-types/streaming_health_services.go -[materialized view]: https://github.com/hashicorp/consul/blob/master/agent/submatview/materializer.go -[SubscribeEndpoint]: https://github.com/hashicorp/consul/blob/master/agent/rpc/subscribe/subscribe.go -[EventPublisher]: https://github.com/hashicorp/consul/blob/master/agent/consul/stream/event_publisher.go -[state.Store commits]: https://github.com/hashicorp/consul/blob/master/agent/consul/state/memdb.go +[rpcclient/health.Health]: https://github.com/hashicorp/consul/blob/main/agent/rpcclient/health/health.go +[StreamingHealthServices cache-type]: https://github.com/hashicorp/consul/blob/main/agent/cache-types/streaming_health_services.go +[materialized view]: https://github.com/hashicorp/consul/blob/main/agent/submatview/materializer.go +[SubscribeEndpoint]: https://github.com/hashicorp/consul/blob/main/agent/rpc/subscribe/subscribe.go +[EventPublisher]: https://github.com/hashicorp/consul/blob/main/agent/consul/stream/event_publisher.go +[state.Store commits]: https://github.com/hashicorp/consul/blob/main/agent/consul/state/memdb.go ## Event Publisher diff --git a/website/content/api-docs/libraries-and-sdks.mdx b/website/content/api-docs/libraries-and-sdks.mdx index 781c404a69..8956436657 100644 --- a/website/content/api-docs/libraries-and-sdks.mdx +++ b/website/content/api-docs/libraries-and-sdks.mdx @@ -15,7 +15,7 @@ the community.