Skip to content

Commit 3dec9db

Browse files
Replace urls in repo pointing to master branch to main
Signed-off-by: Rohit Nayak <[email protected]>
1 parent db5de4f commit 3dec9db

24 files changed

+50
-65
lines changed

GOVERNANCE.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ New committers can be nominated by any existing committer. Once they have been n
5959

6060
Nominees may decline their appointment as a committer. However, this is unusual, as the project does not expect any specific time or resource commitment from its community members. The intention behind the role of committer is to allow people to contribute to the project more easily, not to tie them in to the project in any formal way.
6161

62-
It is important to recognise that commitership is a privilege, not a right. That privilege must be earned and once earned it can be removed by the PMC for conduct inconsistent with the [Guiding Principles](https://github.com/vitessio/vitess/blob/master/GUIDING_PRINCIPLES.md) or if they drop below a level of commitment and engagement required to be a Committer, as determined by the PMC. The PMC also reserves the right to remove a person for any other reason inconsistent with the goals of Vitess.
62+
It is important to recognise that commitership is a privilege, not a right. That privilege must be earned and once earned it can be removed by the PMC for conduct inconsistent with the [Guiding Principles](https://github.com/vitessio/vitess/blob/main/GUIDING_PRINCIPLES.md) or if they drop below a level of commitment and engagement required to be a Committer, as determined by the PMC. The PMC also reserves the right to remove a person for any other reason inconsistent with the goals of Vitess.
6363

6464
A committer who shows an above-average level of contribution to the project, particularly with respect to its strategic direction and long-term health, may be nominated to become a member of the PMC. This role is described below.
6565

@@ -83,7 +83,7 @@ Membership of the PMC is by invitation from the existing PMC members. A nominati
8383

8484
The number of PMC members should be limited to 7. This number is chosen to ensure that sufficient points of view are represented, while preserving the efficiency of the decision making process.
8585

86-
The PMC is responsible for maintaining the [Guiding Principles](https://github.com/vitessio/vitess/blob/master/GUIDING_PRINCIPLES.md) and the code of conduct. It is also responsible for ensuring that those rules and principles are followed.
86+
The PMC is responsible for maintaining the [Guiding Principles](https://github.com/vitessio/vitess/blob/main/GUIDING_PRINCIPLES.md) and the code of conduct. It is also responsible for ensuring that those rules and principles are followed.
8787

8888
## PMC Chair
8989

@@ -106,7 +106,7 @@ The Slack channel list is the most appropriate place for a contributor to ask fo
106106

107107
Decisions about the future of the project are made by the PMC. New proposals and ideas can be brought to the PMC’s attention through the Slack channel or by filing an issue. If necessary, the PMC will seek input from others to come to the final decision.
108108

109-
The PMC’s decision is itself governed by the project’s [Guiding Principles](https://github.com/vitessio/vitess/blob/master/GUIDING_PRINCIPLES.md), which shall be used to reach consensus. If a consensus cannot be reached, a simple majority voting process will be used to reach resolution. In case of a tie, the PMC chair has the casting vote.
109+
The PMC’s decision is itself governed by the project’s [Guiding Principles](https://github.com/vitessio/vitess/blob/main/GUIDING_PRINCIPLES.md), which shall be used to reach consensus. If a consensus cannot be reached, a simple majority voting process will be used to reach resolution. In case of a tie, the PMC chair has the casting vote.
110110

111111
# Credits
112112
The contents of this document are based on http://oss-watch.ac.uk/resources/meritocraticgovernancemodel by Ross Gardler and Gabriel Hanganu.

GUIDING_PRINCIPLES.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ Vitess is driven by high technical standards, and these must be maintained. It i
2424
* Diversity
2525
* Inclusiveness
2626
* Openness
27-
* Adherence to the [Code of Conduct](https://github.com/vitessio/vitess/blob/master/CODE_OF_CONDUCT.md)
27+
* Adherence to the [Code of Conduct](https://github.com/vitessio/vitess/blob/main/CODE_OF_CONDUCT.md)

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@ since 2011, and has grown to encompass tens of thousands of MySQL nodes.
2222
For more about Vitess, please visit [vitess.io](https://vitess.io).
2323

2424
Vitess has a growing community. You can view the list of adopters
25-
[here](https://github.com/vitessio/vitess/blob/master/ADOPTERS.md).
25+
[here](https://github.com/vitessio/vitess/blob/main/ADOPTERS.md).
2626

2727
## Reporting a Problem, Issue, or Bug
28-
To report a problem, the best way to get attention is to create a GitHub [issue](.https://github.com/vitessio/vitess/issues ) using proper severity level based on this [guide](https://github.com/vitessio/vitess/blob/master/SEVERITY.md).
28+
To report a problem, the best way to get attention is to create a GitHub [issue](.https://github.com/vitessio/vitess/issues ) using proper severity level based on this [guide](https://github.com/vitessio/vitess/blob/main/SEVERITY.md).
2929

3030
For topics that are better discussed live, please join the [Vitess Slack](https://vitess.io/slack) workspace.
3131
You may post any questions on the #general channel or join some of the special-interest channels.

SECURITY.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -33,11 +33,11 @@ score >= 4; see below). If the fix relies on another upstream project's disclosu
3333
will adjust the process as well. We will work with the upstream project to fit their timeline and
3434
best protect our users.
3535

36-
#### Policy for master-only vulnerabilities
36+
#### Policy for main-only vulnerabilities
3737

38-
If a security vulnerability affects master, but not a currently supported branch, then the following process will apply:
38+
If a security vulnerability affects main, but not a currently supported branch, then the following process will apply:
3939

40-
* The fix will land in master.
40+
* The fix will land in main.
4141
* A courtesy notice will be posted in #developers on Vitess Slack.
4242

4343
#### Policy for unsupported releases

doc/DockerBuild.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
By default, the [Helm Charts](https://github.com/vitessio/vitess/tree/master/helm)
1+
By default, the [Helm Charts](https://github.com/vitessio/vitess/tree/main/helm)
22
point to the `vitess/lite` image on [Docker Hub](https://hub.docker.com/u/vitess/).
33

44
We created the `lite` image as a stripped down version of our main image `base` such that Kubernetes pods can start faster.
55
The `lite` image does not change very often and is updated manually by the Vitess team with every release.
66
In contrast, the `base` image is updated automatically after every push to the GitHub master branch.
7-
For more information on the different images we provide, please read the [`docker/README.md`](https://github.com/vitessio/vitess/tree/master/docker) file.
7+
For more information on the different images we provide, please read the [`docker/README.md`](https://github.com/vitessio/vitess/tree/main/docker) file.
88

99
If your goal is run the latest Vitess code, the simplest solution is to use the bigger `base` image instead of `lite`.
1010

@@ -22,9 +22,9 @@ Then you can run our build script for the `lite` image which extracts the Vitess
2222

2323
1. Go to your `src/vitess.io/vitess` directory.
2424

25-
1. Usually, you won't need to [build your own bootstrap image](https://github.com/vitessio/vitess/blob/master/docker/bootstrap/README.md)
26-
unless you edit [bootstrap.sh](https://github.com/vitessio/vitess/blob/master/bootstrap.sh)
27-
or [vendor.json](https://github.com/vitessio/vitess/blob/master/vendor/vendor.json),
25+
1. Usually, you won't need to [build your own bootstrap image](https://github.com/vitessio/vitess/blob/main/docker/bootstrap/README.md)
26+
unless you edit [bootstrap.sh](https://github.com/vitessio/vitess/blob/main/bootstrap.sh)
27+
or [vendor.json](https://github.com/vitessio/vitess/blob/main/vendor/vendor.json),
2828
for example to add new dependencies. If you do need it then build the
2929
bootstrap image, otherwise pull the image using one of the following
3030
commands depending on the MySQL flavor you want:

doc/LifeOfAQuery.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -11,21 +11,21 @@ Life of A Query
1111

1212
A query means a request for information from database and it involves four components in the case of Vitess, including the client application, VtGate, VtTablet and MySQL instance. This doc explains the interaction which happens between and within components.
1313

14-
![](https://raw.githubusercontent.com/vitessio/vitess/master/doc/life_of_a_query.png)
14+
![](https://raw.githubusercontent.com/vitessio/vitess/main/doc/life_of_a_query.png)
1515

1616
At a very high level, as the graph shows, first the client sends a query to VtGate. VtGate then resolves the query and routes it to the right VtTablets. For each VtTablet that receives the query, it does necessary validations and passes the query to the underlying MySQL instance. After gathering results from MySQL, VtTablet sends the response back to VtGate. Once VtGate receives responses from all VtTablets, it sends the combined result to the client. In the presence of VtTablet errors, VtGate will retry the query if errors are recoverable and it only fails the query if either errors are unrecoverable or the maximum number of retries has been reached.
1717

1818
## From Client to VtGate
1919

2020
A client application first sends an rpc with an embedded sql query to VtGate. VtGate's rpc server unmarshals this rpc request, calls the appropriate VtGate method and return its result back to client.
2121

22-
![](https://raw.githubusercontent.com/vitessio/vitess/master/doc/life_of_a_query_client_to_vtgate.png)
22+
![](https://raw.githubusercontent.com/vitessio/vitess/main/doc/life_of_a_query_client_to_vtgate.png)
2323

2424
VtGate keeps an in-memory table that stores all available rpc methods for each service, e.g. VtGate uses "VTGate" as its service name and most of its methods defined in [go/vt/vtgate/vtgate.go](../go/vt/vtgate/vtgate.go) are used to serve rpc request.
2525

2626
## From VtGate to VtTablet
2727

28-
![](https://raw.githubusercontent.com/vitessio/vitess/master/doc/life_of_a_query_vtgate_to_vttablet.png)
28+
![](https://raw.githubusercontent.com/vitessio/vitess/main/doc/life_of_a_query_vtgate_to_vttablet.png)
2929

3030
After receiving an rpc call from the client and one of its Execute* method being invoked, VtGate needs to figure out which shards should receive the query and send it to each of them. In addition, VtGate talks to the topo server to get necessary information to create a VtTablet connection for each shard. At this point, VtGate is able to send the query to the right VtTablets in parallel. VtGate also does retry if timeout happens or some VtTablets return recoverable errors.
3131

@@ -35,13 +35,13 @@ A ShardConn object represents a load balanced connection to a group of VtTablets
3535

3636
## From VtTablet to MySQL
3737

38-
![](https://raw.githubusercontent.com/vitessio/vitess/master/doc/life_of_a_query_vttablet_to_mysql.png)
38+
![](https://raw.githubusercontent.com/vitessio/vitess/main/doc/life_of_a_query_vttablet_to_mysql.png)
3939

4040
Once VtTablet received an rpc call from VtGate, it does a few checks before passing the query to MySQL. First, it validates the current VtTablet state including the session id, then generates a query plan and applies predefined query rules and does ACL checks. It also checks whether the query hits the row cache and returns the result immediately if so. In addition, VtTablet consolidates duplicate queries from executing simultaneously and shares results between them. At this point, VtTablet has no way but pass the query down to MySQL layer and wait for the result.
4141

4242
## Putting it all together
4343

44-
![](https://raw.githubusercontent.com/vitessio/vitess/master/doc/life_of_a_query_all.png)
44+
![](https://raw.githubusercontent.com/vitessio/vitess/main/doc/life_of_a_query_all.png)
4545

4646
## TopoServer
4747

doc/ReplicatoinLagBasedThrottlingOfTransactions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,11 @@ A boolean flag controlling whether the replication-lag-based throttling is enabl
2121

2222
* *tx-throttler-config*
2323

24-
A text-format representation of the [throttlerdata.Configuration](https://github.com/vitessio/vitess/blob/master/proto/throttlerdata.proto) protocol buffer
24+
A text-format representation of the [throttlerdata.Configuration](https://github.com/vitessio/vitess/blob/main/proto/throttlerdata.proto) protocol buffer
2525
that contains configuration options for the throttler.
2626
The most important fields in that message are *target_replication_lag_sec* and
2727
*max_replication_lag_sec* that specify the desired limits on the replication lag. See the comments in the protocol definition file for more details.
28-
If this is not specified a [default](https://github.com/vitessio/vitess/tree/master/go/vt/vttablet/tabletserver/tabletenv/config.go) configuration will be used.
28+
If this is not specified a [default](https://github.com/vitessio/vitess/tree/main/go/vt/vttablet/tabletserver/tabletenv/config.go) configuration will be used.
2929

3030
* *tx-throttler-healthcheck-cells*
3131

doc/TwoPhaseCommitDesign.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ For #1 and #2, the Rollback workflow is initiated. For #3, the commit is resumed
106106

107107
The following diagram illustrates the life-cycle of a Vitess transaction.
108108

109-
![](https://raw.githubusercontent.com/vitessio/vitess/master/doc/TxLifecycle.png)
109+
![](https://raw.githubusercontent.com/vitessio/vitess/main/doc/TxLifecycle.png)
110110

111111
A transaction generally starts off as a single DB transaction. It becomes a distributed transaction as soon as more than one VTTablet is affected. If the app issues a rollback, then all participants are simply rolled back. If a BEC is issued, then all transactions are individually committed. These actions are the same irrespective of single or distributed transactions.
112112

@@ -132,7 +132,7 @@ In order to make 2PC work, the following pieces of functionality have to be buil
132132

133133
The diagram below show how the various components interact.
134134

135-
![](https://raw.githubusercontent.com/vitessio/vitess/master/doc/TxInteractions.png)
135+
![](https://raw.githubusercontent.com/vitessio/vitess/main/doc/TxInteractions.png)
136136

137137
The detailed design explains all the functionalities and interactions.
138138

doc/V3HighLevelDesign.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The goal of this document is to describe the guiding principles that will be use
66

77
### Prerequisites
88

9-
Before reading this doc you must be familiar with [vindexes](https://github.com/vitessio/vitess/blob/master/doc/V3VindexDesign.md), which is used as foundation for the arguments presented here.
9+
Before reading this doc you must be familiar with [vindexes](https://github.com/vitessio/vitess/blob/main/doc/V3VindexDesign.md), which is used as foundation for the arguments presented here.
1010

1111
# Background
1212

@@ -1194,7 +1194,7 @@ The overall strategy is as follows:
11941194

11951195
In order to align ourselves with our priorities, we’ll start off with a limited set of primitives, and then we can expand from there.
11961196

1197-
VTGate already has `Route` and `RouteMerge` as primitives. To this list, let’s add `Join` and `LeftJoin`. Using these primitives, we should be able to cover priorities 1-3 (mentioned in the [Prioritization](https://github.com/vitessio/vitess/blob/master/doc/V3HighLevelDesign.md#prioritization) section). So, any constructs that will require VTGate to do additional work will not be supported. Here’s a recap of what each primitive must do:
1197+
VTGate already has `Route` and `RouteMerge` as primitives. To this list, let’s add `Join` and `LeftJoin`. Using these primitives, we should be able to cover priorities 1-3 (mentioned in the [Prioritization](https://github.com/vitessio/vitess/blob/main/doc/V3HighLevelDesign.md#prioritization) section). So, any constructs that will require VTGate to do additional work will not be supported. Here’s a recap of what each primitive must do:
11981198

11991199
* `Route`: Sends a query to a single shard or unsharded keyspace.
12001200
* `RouteMerge`: Sends a (mostly) identical query to multiple shards and returns the combined results in no particular order.

doc/VTGateSubqueries.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Introduction
44

5-
This document builds on top of [The V3 high level design](https://github.com/vitessio/vitess/blob/master/doc/V3HighLevelDesign.md). It discusses implementation of subquery support in greater detail.
5+
This document builds on top of [The V3 high level design](https://github.com/vitessio/vitess/blob/main/doc/V3HighLevelDesign.md). It discusses implementation of subquery support in greater detail.
66

77

88

doc/VTGateV3Features.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ there are some additional benefits:
3434
underneath without changing much of the app.
3535

3636
The
37-
[V3 design](https://github.com/vitessio/vitess/blob/master/doc/V3VindexDesign.md)
37+
[V3 design](https://github.com/vitessio/vitess/blob/main/doc/V3VindexDesign.md)
3838
is quite elaborate. If necessary, it will allow you to plug in custom indexes
3939
and sharding schemes. However, it comes equipped with some pre-cooked recipes
4040
that satisfy the immediate needs of the real-world:

doc/VindexAsTable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ One can think of a vindex as a table that looks like this:
1010
create my_vdx(id int, keyspace_id varbinary(255)) // id can be of any type.
1111
```
1212

13-
Looking at the vindex interface defined [here](https://github.com/vitessio/vitess/blob/master/go/vt/vtgate/vindexes/vindex.go), we can come up with SQL syntax that represents them:
13+
Looking at the vindex interface defined [here](https://github.com/vitessio/vitess/blob/main/go/vt/vtgate/vindexes/vindex.go), we can come up with SQL syntax that represents them:
1414
* Map: `select id, keyspace_id from my_vdx where id = :id`.
1515
* Create: `insert into my_vdx values(:id, :keyspace_id)`.
1616
* Delete: `delete from my_vdx where id = :id and keyspace_id :keyspace_id`.

doc/Vision.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,4 @@ data is stored only once, and fetched only if needed.
7070

7171
The following diagram illustrates where vitess fits in the spectrum of storage solutions:
7272

73-
![Spectrum](https://raw.github.com/vitessio/vitess/master/doc/VitessSpectrum.png)
73+
![Spectrum](https://raw.github.com/vitessio/vitess/main/doc/VitessSpectrum.png)

doc/internal/ReleaseInstructions.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ backward-incompatible way -- for example, when removing deprecated interfaces.
1313

1414
Our public API includes (but is not limited to):
1515

16-
* The VTGate [RPC interfaces](https://github.com/vitessio/vitess/tree/master/proto).
16+
* The VTGate [RPC interfaces](https://github.com/vitessio/vitess/tree/main/proto).
1717
* The interfaces exposed by the VTGate client library in each language.
1818

1919
Care must also be taken when changing the format of any data stored by a live

doc/releasenotes/8_0_0_release_notes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ If a scatter query is attempting to collect and process too many rows in memory
107107

108108

109109
### Set Statement Support
110-
Set statement support is added in Vitess. There are [some system variables](https://github.com/vitessio/vitess/blob/master/go/vt/sysvars/sysvars.go#L147,L190) which are disabled by default and can be enabled using flag `-enable_system_settings` on VTGate.These system variables are set on the backing MySQL instance, and will force the connection to be dedicated instead of part of the connection pool.
110+
Set statement support is added in Vitess. There are [some system variables](https://github.com/vitessio/vitess/blob/main/go/vt/sysvars/sysvars.go#L147,L190) which are disabled by default and can be enabled using flag `-enable_system_settings` on VTGate.These system variables are set on the backing MySQL instance, and will force the connection to be dedicated instead of part of the connection pool.
111111

112112
* Disabled passthrough system variables by default. #6859
113113
* Allow switching workload between OLAP and OLTP #4086 #6691

doc/releasenotes/9_0_0_release_notes.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ Vitess 9.0 is not compatible with the previous release of the Vitess Kubernetes
100100

101101
### Set Statement Support
102102

103-
Set statement support has been added in Vitess. There are [some system variables](https://github.com/vitessio/vitess/blob/master/go/vt/sysvars/sysvars.go#L147,L190) which are disabled by default and can be enabled using flag `-enable_system_settings` on VTGate. These system variables are set on the mysql server. Because they change the mysql session, using them leads to the Vitess connection no longer using the connection pool and forcing dedicated connections.
103+
Set statement support has been added in Vitess. There are [some system variables](https://github.com/vitessio/vitess/blob/main/go/vt/sysvars/sysvars.go#L147,L190) which are disabled by default and can be enabled using flag `-enable_system_settings` on VTGate. These system variables are set on the mysql server. Because they change the mysql session, using them leads to the Vitess connection no longer using the connection pool and forcing dedicated connections.
104104

105105

106106
### VReplication

0 commit comments

Comments
 (0)