Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/bugs.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Bugs

Please report bugs on the [Issues page](https://github.com/openark/orchestrator/issues)
Please report bugs on the [Issues page](https://github.com/proxysql/orchestrator/issues)
2 changes: 1 addition & 1 deletion docs/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Requirements:
Run:

```
git clone git@github.com:openark/orchestrator.git
git clone git@github.com:proxysql/orchestrator.git
cd orchestrator
```

Expand Down
2 changes: 1 addition & 1 deletion docs/ci-env.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Assuming `orchestrator` is built into `bin/orchestrator` (`./script/build` if no
$ bin/orchestrator --config=conf/orchestrator-ci-env.conf.json --debug http
```

[`conf/orchestrator-ci-env.conf.json`](https://github.com/openark/orchestrator/blob/master/conf/orchestrator-ci-env.conf.json) is designed to work with `orchestrator-ci-env`.
[`conf/orchestrator-ci-env.conf.json`](https://github.com/proxysql/orchestrator/blob/master/conf/orchestrator-ci-env.conf.json) is designed to work with `orchestrator-ci-env`.

You may choose to change the value of `SQLite3DataFile`, which is by default on `/tmp`.

Expand Down
8 changes: 4 additions & 4 deletions docs/ci.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

## Build

Running on pull requests, the [main CI](https://github.com/openark/orchestrator/blob/master/.github/workflows/main.yml) job validates the following:
Running on pull requests, the [main CI](https://github.com/proxysql/orchestrator/blob/master/.github/workflows/main.yml) job validates the following:

- Validate source code is formatted using `gofmt`
- Build passes
Expand All @@ -18,18 +18,18 @@ Running on pull requests, the [main CI](https://github.com/openark/orchestrator/
- Using `MySQL` backend
- Documentation tests pass: ensuring pages and links are not orphaned.

The [action](https://github.com/openark/orchestrator/actions?query=workflow%3ACI) completes by producing an artifact: an `orchestrator` binary for Linux `amd64`. The artifact is kept for a couple months per GitHub Actions policy.
The [action](https://github.com/proxysql/orchestrator/actions?query=workflow%3ACI) completes by producing an artifact: an `orchestrator` binary for Linux `amd64`. The artifact is kept for a couple months per GitHub Actions policy.

## Upgrade

[Upgrade](https://github.com/openark/orchestrator/blob/master/.github/workflows/upgrade.yml) runs on pull requests, tests a successful upgrade path from previous version (ie `master`) to PR's branch. This mainly tests internal database structure changes. The test:
[Upgrade](https://github.com/proxysql/orchestrator/blob/master/.github/workflows/upgrade.yml) runs on pull requests, tests a successful upgrade path from previous version (ie `master`) to PR's branch. This mainly tests internal database structure changes. The test:

- Checks out `master` and run `orchestrator`, once using `SQLite`, once using `MySQL`
- Checks out `HEAD` (PR's branch) and run `orchestrator` using pre-existing `SQLite` and `MySQL` backends. Expect no error.

## System

[System tests](https://github.com/openark/orchestrator/blob/master/.github/workflows/system.yml) run as a scheduled job. A system test:
[System tests](https://github.com/proxysql/orchestrator/blob/master/.github/workflows/system.yml) run as a scheduled job. A system test:

- Sets up a [CI environment](https://github.com/openark/orchestrator-ci-env) which includes:
- A replication topology via [DBDeployer](https://www.dbdeployer.com/), with heartbeat injection
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration-discovery-pseudo-gtid.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,4 +58,4 @@ If you wish to inject Pseudo-GTID yourself, we suggest you should configure as f
The above assumes:

- You have a `meta` schema
- You will inject Pseudo-GTID entries via [this sample script](https://github.com/openark/orchestrator/tree/master/resources/pseudo-gtid)
- You will inject Pseudo-GTID entries via [this sample script](https://github.com/proxysql/orchestrator/tree/master/resources/pseudo-gtid)
2 changes: 1 addition & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Documenting and explaining all configuration variables turns to be a daunting task, as goes as deep as explain-the-code-in-words. There is an ongoing effort in pruning and simplifying the configuration.

The de-facto configuration list is located in [config.go](https://github.com/openark/orchestrator/blob/master/go/config/config.go).
The de-facto configuration list is located in [config.go](https://github.com/proxysql/orchestrator/blob/master/go/config/config.go).

You are undoubtedly interested in configuring some basic components: the backend database, hosts discoveries. You may choose to use Pseudo-GTID. You may want `orchestrator` to notify upon failure, or you may wish to run full blown automated recovery.

Expand Down
12 changes: 6 additions & 6 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Multiple Dockerfiles are available, to:
- Run a 3-node raft setup
- Run a full blown CI environment

[`script/dock`](https://github.com/openark/orchestrator/blob/master/script/dock) is a convenience script to build/spawn each of these docker images.
[`script/dock`](https://github.com/proxysql/orchestrator/blob/master/script/dock) is a convenience script to build/spawn each of these docker images.

## Build and test

Expand All @@ -19,15 +19,15 @@ If you wish to build and test on your host, but do not want to set up a developm
$ script/dock test
```

This will use [`docker/Dockerfile.test`](https://github.com/openark/orchestrator/blob/master/docker/Dockerfile.test) to build, unit test, integration test, run doc validation on your behalf.
This will use [`docker/Dockerfile.test`](https://github.com/proxysql/orchestrator/blob/master/docker/Dockerfile.test) to build, unit test, integration test, run doc validation on your behalf.

## Build and run

Run this command:
```shell
$ script/dock alpine
```
which uses [`docker/Dockerfile`](https://github.com/openark/orchestrator/blob/master/docker/Dockerfile) to build `orchestrator` on an Alpine Linux, and run the service. Docker will map port `:3000` onto your machine, you may browse onto `http://127.0.0.1:3000` to access the orchestrator web interface.
which uses [`docker/Dockerfile`](https://github.com/proxysql/orchestrator/blob/master/docker/Dockerfile) to build `orchestrator` on an Alpine Linux, and run the service. Docker will map port `:3000` onto your machine, you may browse onto `http://127.0.0.1:3000` to access the orchestrator web interface.

The following environment variables are available and take effect if no config
file is bind mounted into container at `/etc/orchestrator.conf.json`
Expand All @@ -53,9 +53,9 @@ To create (via [`fpm`](https://fpm.readthedocs.io/en/latest/)) release packages:
- `.rpm`
- `.tgz`

for Linux `amd64`, with `Systemd` or `SysVinit`, all binaries or just client scripts. It uses the same methods as used for [official releases](https://github.com/openark/orchestrator/releases).
for Linux `amd64`, with `Systemd` or `SysVinit`, all binaries or just client scripts. It uses the same methods as used for [official releases](https://github.com/proxysql/orchestrator/releases).

Uses [`Dockerfile.packaging`](https://github.com/openark/orchestrator/blob/master/docker/Dockerfile.packaging)
Uses [`Dockerfile.packaging`](https://github.com/proxysql/orchestrator/blob/master/docker/Dockerfile.packaging)

## Run full CI environment

Expand All @@ -81,7 +81,7 @@ Tips:
`mysqladmin -uci -pci -h 127.0.0.1 --port 13306 processlist`
- Use `redeploy-ci-env` to re-create the MySQL topology, and recreate and restart the heartbeat, consul, consul-template and haproxy services. This resets the services to their original state.

Uses [`Dockerfile.system`](https://github.com/openark/orchestrator/blob/master/docker/Dockerfile.system)
Uses [`Dockerfile.system`](https://github.com/proxysql/orchestrator/blob/master/docker/Dockerfile.system)

## Run a raft setup

Expand Down
6 changes: 3 additions & 3 deletions docs/download.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Download

`orchestrator` is released as open source and is available at [GitHub](https://github.com/openark/orchestrator).
Find official releases in https://github.com/openark/orchestrator/releases
`orchestrator` is released as open source and is available at [GitHub](https://github.com/proxysql/orchestrator).
Find official releases in https://github.com/proxysql/orchestrator/releases
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability, this URL could be formatted as a markdown link.

Suggested change
Find official releases in https://github.com/proxysql/orchestrator/releases
Find official releases on the [releases page](https://github.com/proxysql/orchestrator/releases)


`orchestrator` packages can be found in https://packagecloud.io/github/orchestrator

For developers: `orchestrator` is go-gettable. Issue:

go get github.com/openark/orchestrator/...
go get github.com/proxysql/orchestrator/...
Copy link

Copilot AI Mar 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The go get github.com/proxysql/orchestrator/... instruction is likely to fail right now because go.mod still declares the module path as github.com/openark/orchestrator (Go will error on a module path mismatch). Either keep the go get line pointing at github.com/openark/orchestrator/... until the module path migration lands, or adjust the text to explain that cloning/building from source works but Go module consumers must still use the old import path for now.

Suggested change
go get github.com/proxysql/orchestrator/...
go get github.com/openark/orchestrator/...

Copilot uses AI. Check for mistakes.

See [Orchestrator for developers](developers.md)
2 changes: 1 addition & 1 deletion docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ No.

### Is orchestrator open source?

Yes. `Orchestrator` is released as open source under the Apache License 2.0 and is available at: https://github.com/openark/orchestrator
Yes. `Orchestrator` is released as open source under the Apache License 2.0 and is available at: https://github.com/proxysql/orchestrator
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability and consistency, this URL could be formatted as a markdown link.

Suggested change
Yes. `Orchestrator` is released as open source under the Apache License 2.0 and is available at: https://github.com/proxysql/orchestrator
Yes. `Orchestrator` is released as open source under the Apache License 2.0 and is available on [GitHub](https://github.com/proxysql/orchestrator)


### Who develops orchestrator and why?

Expand Down
4 changes: 2 additions & 2 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ If not, replace `127.0.0.1` with appropriate host name. Replace `orch_backend_pa

- Extract from tarball

Extract the archive you've downloaded from https://github.com/percona/orchestrator/tags
Extract the archive you've downloaded from https://github.com/proxysql/orchestrator/tags
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability, this URL could be formatted as a markdown link.

Suggested change
Extract the archive you've downloaded from https://github.com/proxysql/orchestrator/tags
Extract the archive you've downloaded from the [tags page](https://github.com/proxysql/orchestrator/tags)

For example, let's assume you wish to install `orchestrator` under `/usr/local/orchestrator`:

sudo mkdir -p /usr/local
Expand Down Expand Up @@ -45,7 +45,7 @@ Setup a MySQL server for backend, and invoke the following:
`Orchestrator` uses a configuration file, located in either `/etc/orchestrator.conf.json` or relative path to binary `conf/orchestrator.conf.json` or
`orchestrator.conf.json`.

Tip: the installed package includes a file called `orchestrator.conf.json.sample` with some basic settings which you can use as baseline for `orchestrator.conf.json`. It is found in `/usr/local/orchestrator/orchestrator-sample.conf.json` and you may also find `/usr/local/orchestrator/orchestrator-sample-sqlite.conf.json` which has a SQLite-oriented configuration. Those sample files are also available [on the `orchestrator` repository](https://github.com/percona/orchestrator/tree/master/conf).
Tip: the installed package includes a file called `orchestrator.conf.json.sample` with some basic settings which you can use as baseline for `orchestrator.conf.json`. It is found in `/usr/local/orchestrator/orchestrator-sample.conf.json` and you may also find `/usr/local/orchestrator/orchestrator-sample-sqlite.conf.json` which has a SQLite-oriented configuration. Those sample files are also available [on the `orchestrator` repository](https://github.com/proxysql/orchestrator/tree/master/conf).

Edit `orchestrator.conf.json` to match the above as follows:

Expand Down
4 changes: 2 additions & 2 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
`orchestrator` is released under the Apache License 2.0.

See [LICENSE](https://github.com/openark/orchestrator/blob/master/LICENSE)
See [LICENSE](https://github.com/proxysql/orchestrator/blob/master/LICENSE)

This repository includes 3rd party libraries which have their own licenses. These libraries are found under https://github.com/openark/orchestrator/tree/master/vendor
This repository includes 3rd party libraries which have their own licenses. These libraries are found under https://github.com/proxysql/orchestrator/tree/master/vendor
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability, this URL could be formatted as a markdown link.

Suggested change
This repository includes 3rd party libraries which have their own licenses. These libraries are found under https://github.com/proxysql/orchestrator/tree/master/vendor
This repository includes 3rd party libraries which have their own licenses. These libraries are found under the [`vendor` directory](https://github.com/proxysql/orchestrator/tree/master/vendor)

2 changes: 1 addition & 1 deletion docs/orchestrator-client.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# orchestrator-client

[orchestrator-client](https://github.com/openark/orchestrator/blob/master/resources/bin/orchestrator-client) is a script that wraps API calls with convenient command line interface.
[orchestrator-client](https://github.com/proxysql/orchestrator/blob/master/resources/bin/orchestrator-client) is a script that wraps API calls with convenient command line interface.

It can auto-determine the leader of an `orchestrator` setup and in such case forward all requests to the leader.

Expand Down
2 changes: 1 addition & 1 deletion docs/pseudo-gtid-manual-injection.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ for more detail.

Injecting Pseudo GTID can be done via:
- MySQL's [event_scheduler](https://dev.mysql.com/doc/refman/5.7/en/event-scheduler.html) (see examples below)
- External injection, see [sample files](https://github.com/openark/orchestrator/tree/master/resources/pseudo-gtid):
- External injection, see [sample files](https://github.com/proxysql/orchestrator/tree/master/resources/pseudo-gtid):
- script to inject pseudo-gtid
- start-stop script to serve as daemon on `/etc/init.d/pseudo-gtid`
- a puppet module.
Expand Down
2 changes: 1 addition & 1 deletion docs/risks.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ Failovers are inherently tied to your deployments through hooks.

There's always risk with failovers. Make sure to test them.

Please make sure to read the [LICENSE](https://github.com/openark/orchestrator/blob/master/LICENSE), and especially the "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND" part.
Please make sure to read the [LICENSE](https://github.com/proxysql/orchestrator/blob/master/LICENSE), and especially the "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND" part.
2 changes: 1 addition & 1 deletion docs/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Question: Is orchestrator used by many people?
Answer: Right now there is no full list of people
who are actively using it so it seemed like a good idea to generate a page
of current users. If your name or your company's name is missing from this and
you would like to be added please send a pull request to github.com/openark/orchestrator/pulls
you would like to be added please send a pull request to github.com/proxysql/orchestrator/pulls
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

For better readability and user experience, it would be good to format this URL as a markdown link and improve the sentence structure slightly.

Suggested change
you would like to be added please send a pull request to github.com/proxysql/orchestrator/pulls
you would like to be added, please [send a pull request](https://github.com/proxysql/orchestrator/pulls).


Please keep this list in alphabetical order and include the company name and url and
a short description of usage.
Expand Down
4 changes: 2 additions & 2 deletions docs/using-the-web-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ By way of example:

### Full listing

The de-facto listing is the code, please see [api.go](https://github.com/openark/orchestrator/blob/master/go/http/api.go) (scroll down to `RegisterRequests`).
The de-facto listing is the code, please see [api.go](https://github.com/proxysql/orchestrator/blob/master/go/http/api.go) (scroll down to `RegisterRequests`).

You may also appreciate looking at [orchestrator-client](orchestrator-client.md) ([source code](https://github.com/openark/orchestrator/blob/master/resources/bin/orchestrator-client)) to see how command line interface is translated to API calls.
You may also appreciate looking at [orchestrator-client](orchestrator-client.md) ([source code](https://github.com/proxysql/orchestrator/blob/master/resources/bin/orchestrator-client)) to see how command line interface is translated to API calls.

Or, just use the [orchestrator-client](orchestrator-client.md) as your API client, this is what it was made for.

Expand Down
Loading