README
¶
This is a temporary README. We'll restore the old README prior to PR upstream.
Consul Connect
This repository is the forked repository for Consul Connect work to happen in private prior to public release. This README will explain how to safely use this fork, how to bring in upstream changes, etc.
Cloning
To use this repository, clone it into your GOPATH as usual but you must
rename consul-connect to consul so that Go imports continue working
as usual.
Important: Never Modify Master
NEVER MODIFY MASTER! NEVER MODIFY MASTER!
We want to keep the "master" branch equivalent to OSS master. This will make
rebasing easy for master. Instead, we'll use the branch f-connect. All
feature branches should branch from f-connect and make PRs against
f-connect.
When we're ready to merge back to upstream, we can make a single mega PR
merging f-connect into OSS master. This way we don't have a sudden mega
push to master on OSS.
Creating a Feature Branch
To create a feature branch, branch from f-connect:
git checkout f-connect
git checkout -b my-new-branch
All merged Connect features will be in f-connect, so you want to work
from that branch. When making a PR for your feature branch, target the
f-connect branch as the merge target. You can do this by using the dropdowns
in the GitHub UI when creating a PR.
Syncing Upstream
First update our local master:
# This has to happen on forked master
git checkout master
# Add upstream to OSS Consul
git remote add upstream https://github.com/hashicorp/consul.git
# Fetch it
git fetch upstream
# Rebase forked master onto upstream. This should have no changes since
# we're never modifying master.
git rebase upstream master
Next, update the f-connect branch:
git checkout f-connect
git rebase origin master
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
ae
Package ae provides tools to synchronize state between local and remote consul servers.
|
Package ae provides tools to synchronize state between local and remote consul servers. |
|
cache
Package cache provides caching features for data from a Consul server.
|
Package cache provides caching features for data from a Consul server. |
|
cache-types
Code generated by mockery v1.0.0
|
Code generated by mockery v1.0.0 |
|
consul
The snapshot endpoint is a special non-RPC endpoint that supports streaming for taking and restoring snapshots for disaster recovery.
|
The snapshot endpoint is a special non-RPC endpoint that supports streaming for taking and restoring snapshots for disaster recovery. |
|
proxy
Package proxy contains logic for agent interaction with proxies, primarily "managed" proxies.
|
Package proxy contains logic for agent interaction with proxies, primarily "managed" proxies. |
|
router
Package servers provides a Manager interface for Manager managed metadata.Server objects.
|
Package servers provides a Manager interface for Manager managed metadata.Server objects. |
|
The /v1/operator/area endpoints are available only in Consul Enterprise and interact with its network area subsystem.
|
The /v1/operator/area endpoints are available only in Consul Enterprise and interact with its network area subsystem. |
|
certgen
certgen: a tool for generating test certificates on disk for use as test-fixtures and for end-to-end testing and local development.
|
certgen: a tool for generating test certificates on disk for use as test-fixtures and for end-to-end testing and local development. |
|
freeport
Package freeport provides a helper for allocating free ports across multiple processes on the same machine.
|
Package freeport provides a helper for allocating free ports across multiple processes on the same machine. |
|
The archive utilities manage the internal format of a snapshot, which is a tar file with the following contents: meta.json - JSON-encoded snapshot metadata from Raft state.bin - Encoded snapshot data from Raft SHA256SUMS - SHA-256 sums of the above two files The integrity information is automatically created and checked, and a failure there just looks like an error to the caller.
|
The archive utilities manage the internal format of a snapshot, which is a tar file with the following contents: meta.json - JSON-encoded snapshot metadata from Raft state.bin - Encoded snapshot data from Raft SHA256SUMS - SHA-256 sums of the above two files The integrity information is automatically created and checked, and a failure there just looks like an error to the caller. |
|
retry
Package retry provides support for repeating operations in tests.
|
Package retry provides support for repeating operations in tests. |