From ddb708a2a511f946324c2196f9f8da239ca4bfff Mon Sep 17 00:00:00 2001 From: Joao Eduardo Luis Date: Sat, 16 Mar 2024 09:34:26 +0000 Subject: [PATCH] s3gw: replace 'aquarist-labs' with 's3gw-tech' Not everywhere though. All existing decisions under 'docs/decisions' have been kept in their original form. Signed-off-by: Joao Eduardo Luis --- .pre-commit-config.yaml | 1 - CONTRIBUTING.md | 18 ++++----- README.md | 20 ++++----- docs/config-s3gw.md | 4 +- docs/contributing.md | 2 +- docs/decisions/README.md | 2 +- docs/developing.md | 6 +-- docs/helm-charts.md | 4 +- docs/ideas/PID-0-reserved.md | 2 +- docs/index.md | 8 ++-- docs/quickstart.md | 4 +- docs/readme.md | 10 ++--- docs/roadmap.md | 54 ++++++++++++------------- docs/s3gw-repos.md | 10 ++--- docs/testing.md | 4 +- mkdocs.yml | 6 +-- tools/s3tests/README.md | 6 +-- tools/s3tests/run_local_build_s3test.sh | 4 +- 18 files changed, 82 insertions(+), 83 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index f91d1130..c6f62941 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -52,7 +52,6 @@ repos: rev: 23.11.0 hooks: - id: black - language_version: python3.10 files: (?x)^tools/(release|s3tests)/.+\.py$ - repo: https://github.com/pycqa/isort diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 32fd230d..1855f3ad 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,11 +3,11 @@ The 5 repositories used for the s3gw are located within our main GitHub organization. -- Main: -- Ceph: -- UI: -- Charts: -- COSI: +- Main: +- Ceph: +- UI: +- Charts: +- COSI: We welcome new feature implementations, patches that fix bugs or code cleanup. @@ -16,7 +16,7 @@ We welcome new feature implementations, patches that fix bugs or code cleanup. You can clone from GitHub with: ```bash -git clone https://github.com/aquarist-labs/s3gw +git clone https://github.com/s3gw-tech/s3gw ``` This applies to all the repositories. @@ -24,7 +24,7 @@ This applies to all the repositories. ### Submitting Bugs and Requesting New Features All bugs and feature requests can be filed in "Issues" in -[the s3gw Project](https://github.com/aquarist-labs/s3gw/issues/new/choose). We +[the s3gw Project](https://github.com/s3gw-tech/s3gw/issues/new/choose). We use GitHub templates to manage the requests. You will either select: - Backlog item @@ -72,7 +72,7 @@ For example: ```bash backend: add initial README doc - This commit introduces the first README doc for aquarist-labs. + This commit introduces the first README doc for s3gw-tech. Signed-off-by: Random Developer ``` @@ -95,7 +95,7 @@ Finally, please be sure to sign all commits with your GPG key (`git commit -S`). ### Pull Request Best Practices PRs should be opened on branches contained in your fork of -`aquarist-labs/s3gw.git`. PRs should target the `main` branch. +`s3gw-tech/s3gw.git`. PRs should target the `main` branch. If your PR has only one commit, the PR title can be the same as the commit title (and GitHub will suggest this). If the PR has multiple commits, do not accept diff --git a/README.md b/README.md index f72d153c..39b47ba8 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ An easy way to deploy the S3 Gateway on your Kubernetes cluster is via a Helm chart: ```shell -helm repo add s3gw https://aquarist-labs.github.io/s3gw-charts/ +helm repo add s3gw https://s3gw-tech.github.io/s3gw-charts/ helm install s3gw s3gw/s3gw --namespace s3gw-system --create-namespace \ --set publicDomain=YOUR_DOMAIN_NAME \ --set ui.publicDomain=YOUR_DOMAIN_NAME @@ -93,20 +93,20 @@ limitations under the License. ---- -[s3gw]: https://s3gw.io +[s3gw]: https://s3gw.tech [longhorn]: https://longhorn.io [chart-badge]: https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/s3gw [chart-link]: https://artifacthub.io/packages/search?repo=s3gw [docs-badge]: https://readthedocs.org/projects/s3gw-docs/badge/?version=latest [docs-link]: https://s3gw-docs.readthedocs.io/en/latest/?badge=latest -[issues-badge]: https://img.shields.io/github/issues/aquarist-labs/s3gw -[issues-link]: https://github.com/aquarist-labs/s3gw/issues -[license-badge]: https://img.shields.io/github/license/aquarist-labs/s3gw -[license-link]: https://github.com/aquarist-labs/s3gw/blob/main/LICENSE -[linter-badge]: https://github.com/aquarist-labs/s3gw/actions/workflows/lint.yaml/badge.svg -[linter-link]: https://github.com/aquarist-labs/s3gw/actions/workflows/lint.yaml -[release-badge]: https://img.shields.io/github/v/release/aquarist-labs/s3gw -[release-link]: https://github.com/aquarist-labs/s3gw/releases/latest +[issues-badge]: https://img.shields.io/github/issues/s3gw-tech/s3gw +[issues-link]: https://github.com/s3gw-tech/s3gw/issues +[license-badge]: https://img.shields.io/github/license/s3gw-tech/s3gw +[license-link]: https://github.com/s3gw-tech/s3gw/blob/main/LICENSE +[linter-badge]: https://github.com/s3gw-tech/s3gw/actions/workflows/lint.yaml/badge.svg +[linter-link]: https://github.com/s3gw-tech/s3gw/actions/workflows/lint.yaml +[release-badge]: https://img.shields.io/github/v/release/s3gw-tech/s3gw +[release-link]: https://github.com/s3gw-tech/s3gw/releases/latest [slack-badge]: https://img.shields.io/badge/slack-s3gw-brightgreen.svg?logo=slack [slack-link]: https://slack.com/app_redirect?channel=C04DCMUV8SE [helm-docs]: https://s3gw-docs.readthedocs.io/en/latest/helm-charts/ diff --git a/docs/config-s3gw.md b/docs/config-s3gw.md index 3062e5d7..5f6d20cc 100644 --- a/docs/config-s3gw.md +++ b/docs/config-s3gw.md @@ -227,7 +227,7 @@ environment or for developers. In that case, you can modify the registry and image settings: ```yaml -imageRegistry: "ghcr.io/aquarist-labs" +imageRegistry: "quay.io/s3gw" imageName: "s3gw" imageTag: "latest" imagePullPolicy: "Always" @@ -236,7 +236,7 @@ imagePullPolicy: "Always" To configure the image and registry for the user interface, use: ```yaml -ui.imageRegistry: "ghc.io/aquarist-labs" +ui.imageRegistry: "quay.io/s3gw" ui.imageName: "s3gw-ui" ui.imagePullPolicy: "Always" ui.imageTag: "latest" diff --git a/docs/contributing.md b/docs/contributing.md index f8e8474d..a6e5354d 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,3 +1,3 @@ -{{ external_markdown('https://raw.githubusercontent.com/aquarist-labs/s3gw/main/CONTRIBUTING.md', '') }} +{{ external_markdown('https://raw.githubusercontent.com/s3gw-tech/s3gw/main/CONTRIBUTING.md', '') }} diff --git a/docs/decisions/README.md b/docs/decisions/README.md index 28fe9fc9..71aaf365 100644 --- a/docs/decisions/README.md +++ b/docs/decisions/README.md @@ -6,7 +6,7 @@ This directory contains decision records for s3gw. - Copy `adr-template.md` to `NNNN-title-with-dashes.md` - Edit `NNNN-title-with-dashes.md` -- Create merge request to `aquarist-labs/s3gw` +- Create merge request to `s3gw-tech/s3gw` ## Resources diff --git a/docs/developing.md b/docs/developing.md index feb94bbb..61b84f5f 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -29,7 +29,7 @@ there are two key options available: If you are new to Ceph development, the best way to find out how to build these sources is to refer to the [original Ceph documentation][3]. -The `aquarist-labs/ceph` repository is a requirement for this project. +The `s3gw-tech/s3gw-ceph` repository is a requirement for this project. We can't guarantee that our instructions, or the project as a whole, will work flawlessly with the original Ceph project from `ceph/ceph`. @@ -88,8 +88,8 @@ against the running RGW. E.g., `s3cmd mb s3://foo`, to create a new bucket. -[1]: https://github.com/aquarist-labs/ceph.git -[2]: https://github.com/aquarist-labs/ceph/tree/s3gw +[1]: https://github.com/s3gw-tech/s3gw-ceph.git +[2]: https://github.com/s3gw-tech/s3gw-ceph/tree/s3gw [3]: https://docs.ceph.com/en/pacific/install/build-ceph/#id1 [4]: https://github.com/s3tools/s3cmd diff --git a/docs/helm-charts.md b/docs/helm-charts.md index 366fc114..e4249c95 100644 --- a/docs/helm-charts.md +++ b/docs/helm-charts.md @@ -12,7 +12,7 @@ chmod 700 get_helm.sh Clone the s3gw-charts repo and change directory: ```bash -git clone https://aquarist-labs.github.io/s3gw-charts/ +git clone https://s3gw-tech.github.io/s3gw-charts/ cd s3gw-charts ``` @@ -37,4 +37,4 @@ helm install $RELEASE_NAME charts/s3gw --namespace $S3GW_NAMESPACE \ ``` For details on the various s3gw releases and names, see the release section on -[GitHub](https://github.com/aquarist-labs/s3gw/releases). +[GitHub](https://github.com/s3gw-tech/s3gw/releases). diff --git a/docs/ideas/PID-0-reserved.md b/docs/ideas/PID-0-reserved.md index a6e2c7c2..b2c3e3e2 100644 --- a/docs/ideas/PID-0-reserved.md +++ b/docs/ideas/PID-0-reserved.md @@ -28,7 +28,7 @@ PIDs should observe the following qualities: PID-0 is the only PID record that is allowed to break the file name convention. -All PIDs should be kept under `/docs/ideas/` in the `aquarist-labs/s3gw` +All PIDs should be kept under `/docs/ideas/` in the `s3gw-tech/s3gw` repository. ### PID Structure diff --git a/docs/index.md b/docs/index.md index a0297322..a7fb1619 100644 --- a/docs/index.md +++ b/docs/index.md @@ -43,8 +43,8 @@ apps that do not require petabyte-scale storage. - Designed to integrate with Rancher's product catalog - Open source licensing (Apache 2.0) -[1]: https://github.com/aquarist-labs/ceph -[2]: https://github.com/aquarist-labs/s3gw -[3]: https://github.com/aquarist-labs/s3gw-charts -[4]: https://github.com/aquarist-labs/s3gw-ui +[1]: https://github.com/s3gw-tech/s3gw-ceph +[2]: https://github.com/s3gw-tech/s3gw +[3]: https://github.com/s3gw-tech/s3gw-charts +[4]: https://github.com/s3gw-tech/s3gw-ui [5]: https://longhorn.io/ diff --git a/docs/quickstart.md b/docs/quickstart.md index 7fef1c58..118b10ae 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -6,7 +6,7 @@ You can install the s3gw via the Rancher App Catalog. The steps are as follows: - Cluster -> Projects/Namespaces - create the `s3gw` namespace. - Apps -> Repositories -> Create `s3gw` using the s3gw-charts Web URL - and the main branch. + and the main branch. - Apps -> Charts -> Install Traefik. - Apps -> Charts -> Install `s3gw`. Select the `s3gw` namespace previously created. @@ -32,4 +32,4 @@ docker run -p 7480:7480 quay.io/s3gw/s3gw:latest For more information on building and running a container, read our [guide](../developing/#how-to-build-your-own-containers/). -[1]: https://github.com/aquarist-labs/s3gw/blob/main/docs/helm-charts.md#options +[1]: https://github.com/s3gw-tech/s3gw/blob/main/docs/helm-charts.md#options diff --git a/docs/readme.md b/docs/readme.md index 1e505991..16800dea 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -19,23 +19,23 @@ If you are using Read the Docs for the first time, have a look at the official This is how our documentation is currently structured: -- [docs/](https://github.com/aquarist-labs/s3gw/tree/main/docs) +- [docs/](https://github.com/s3gw-tech/s3gw/tree/main/docs) A basic MkDocs project lives in `docs/`, it was generated using MkDocs defaults. All the `*.md` make up sections in the documentation. -- [.readthedocs.yaml](https://github.com/aquarist-labs/s3gw/tree/main/.readthedocs.yaml) +- [.readthedocs.yaml](https://github.com/s3gw-tech/s3gw/tree/main/.readthedocs.yaml) Read the Docs Build configuration is stored in `.readthedocs.yaml`. -- [mkdocs.yml](https://github.com/aquarist-labs/s3gw/tree/main/mkdocs.yaml) +- [mkdocs.yml](https://github.com/s3gw-tech/s3gw/tree/main/mkdocs.yaml) A [MkDocs configuration](https://www.mkdocs.org/user-guide/configuration/) is stored here, including the navigation structure, a few extensions for MkDocs and Markdown. Add your own configurations here, such as extensions and themes. Remember that many extensions and themes require additional Python packages to be installed. -- [docs/requirements.txt](https://github.com/aquarist-labs/s3gw/tree/main/docs/requirements.txt) +- [docs/requirements.txt](https://github.com/s3gw-tech/s3gw/tree/main/docs/requirements.txt) and -- [docs/requirements.in](https://github.com/aquarist-labs/s3gw/tree/main/docs/requirements.in) +- [docs/requirements.in](https://github.com/s3gw-tech/s3gw/tree/main/docs/requirements.in) Python dependencies are [pinned](https://docs.readthedocs.io/en/latest/guides/reproducible-builds.html) (uses [pip-tools](https://pip-tools.readthedocs.io/en/latest/)) here. Make diff --git a/docs/roadmap.md b/docs/roadmap.md index 59a67156..5907cc2d 100644 --- a/docs/roadmap.md +++ b/docs/roadmap.md @@ -150,30 +150,30 @@ Please note that this roadmap is an evergreen document and will most certainly evolve as we continue to learn from our users. [1]: https://www.figma.com/file/qGWXKomwzIUhsDz7QqixAc/S3-Wireframe---Branded?t=PAXtYcfL0tEPLPmm-1 -[2]: https://github.com/aquarist-labs/s3gw/issues/215 -[3]: https://github.com/aquarist-labs/s3gw/issues/228 -[4]: https://github.com/aquarist-labs/s3gw/issues/256 -[5]: https://github.com/aquarist-labs/s3gw/issues/202 -[7]: https://github.com/aquarist-labs/s3gw/issues/255 -[8]: https://github.com/aquarist-labs/s3gw/issues/257 -[9]: https://github.com/aquarist-labs/s3gw/issues/258 -[10]: https://github.com/aquarist-labs/s3gw/issues/227 -[11]: https://github.com/aquarist-labs/s3gw/issues/271 -[14]: https://github.com/aquarist-labs/s3gw/issues/230 -[16]: https://github.com/aquarist-labs/s3gw/issues/260 -[epic-lh-controller]: https://github.com/aquarist-labs/s3gw/issues/470 -[epic-lh-ui-integration]: https://github.com/aquarist-labs/s3gw/issues/541 -[epic-stable-on-disk]: https://github.com/aquarist-labs/s3gw/issues/428 -[epic-multi-site]: https://github.com/aquarist-labs/s3gw/issues/259 -[epic-cosi-controller]: https://github.com/aquarist-labs/s3gw/issues/398 -[epic-iam-sts]: https://github.com/aquarist-labs/s3gw/issues/229 -[epic-ui-backend]: https://github.com/aquarist-labs/s3gw/issues/388 -[epic-multipart]: https://github.com/aquarist-labs/s3gw/issues/216 -[epic-garbage-collection]: https://github.com/aquarist-labs/s3gw/issues/7 -[epic-object-listing]: https://github.com/aquarist-labs/s3gw/issues/256 -[epic-crash-consistency]: https://github.com/aquarist-labs/s3gw/issues/362 -[epic-e2e-checksums]: https://github.com/aquarist-labs/s3gw/issues/26 -[epic-user-quota]: https://github.com/aquarist-labs/s3gw/issues/359 -[epic-metrics]: https://github.com/aquarist-labs/s3gw/issues/258 -[epic-crd-enhancements]: https://github.com/aquarist-labs/s3gw/issues/629 -[epic-s3select]: https://github.com/aquarist-labs/s3gw/issues/791 +[2]: https://github.com/s3gw-tech/s3gw/issues/215 +[3]: https://github.com/s3gw-tech/s3gw/issues/228 +[4]: https://github.com/s3gw-tech/s3gw/issues/256 +[5]: https://github.com/s3gw-tech/s3gw/issues/202 +[7]: https://github.com/s3gw-tech/s3gw/issues/255 +[8]: https://github.com/s3gw-tech/s3gw/issues/257 +[9]: https://github.com/s3gw-tech/s3gw/issues/258 +[10]: https://github.com/s3gw-tech/s3gw/issues/227 +[11]: https://github.com/s3gw-tech/s3gw/issues/271 +[14]: https://github.com/s3gw-tech/s3gw/issues/230 +[16]: https://github.com/s3gw-tech/s3gw/issues/260 +[epic-lh-controller]: https://github.com/s3gw-tech/s3gw/issues/470 +[epic-lh-ui-integration]: https://github.com/s3gw-tech/s3gw/issues/541 +[epic-stable-on-disk]: https://github.com/s3gw-tech/s3gw/issues/428 +[epic-multi-site]: https://github.com/s3gw-tech/s3gw/issues/259 +[epic-cosi-controller]: https://github.com/s3gw-tech/s3gw/issues/398 +[epic-iam-sts]: https://github.com/s3gw-tech/s3gw/issues/229 +[epic-ui-backend]: https://github.com/s3gw-tech/s3gw/issues/388 +[epic-multipart]: https://github.com/s3gw-tech/s3gw/issues/216 +[epic-garbage-collection]: https://github.com/s3gw-tech/s3gw/issues/7 +[epic-object-listing]: https://github.com/s3gw-tech/s3gw/issues/256 +[epic-crash-consistency]: https://github.com/s3gw-tech/s3gw/issues/362 +[epic-e2e-checksums]: https://github.com/s3gw-tech/s3gw/issues/26 +[epic-user-quota]: https://github.com/s3gw-tech/s3gw/issues/359 +[epic-metrics]: https://github.com/s3gw-tech/s3gw/issues/258 +[epic-crd-enhancements]: https://github.com/s3gw-tech/s3gw/issues/629 +[epic-s3select]: https://github.com/s3gw-tech/s3gw/issues/791 diff --git a/docs/s3gw-repos.md b/docs/s3gw-repos.md index 98fac450..cb37c812 100644 --- a/docs/s3gw-repos.md +++ b/docs/s3gw-repos.md @@ -2,8 +2,8 @@ The S3 Gateway includes the following projects: -- aquarist-labs/s3gw -- aquarist-labs/ceph -- aquarist-labs/s3gw-charts -- aquarist-labs/s3gw-status -- aquarist-labs/s3gw-cosi-driver +- s3gw-tech/s3gw +- s3gw-tech/s3gw-ceph +- s3gw-tech/s3gw-charts +- s3gw-tech/s3gw-status +- s3gw-tech/s3gw-cosi-driver diff --git a/docs/testing.md b/docs/testing.md index 4b07dbde..dd2b4de0 100644 --- a/docs/testing.md +++ b/docs/testing.md @@ -40,9 +40,9 @@ This script requires the resulting log file from an `s3gw-s3tests.sh` run. The report is a `json` file containing relevant information about the run, and is meant to be shared via the -[aquarist-labs/s3gw-status](https://github.com/aquarist-labs/s3gw-status) +[s3gw-tech/s3gw-status](https://github.com/s3gw-tech/s3gw-status) repository (see more information on the [project's README -file](https://github.com/aquarist-labs/s3gw-status#readme).) +file](https://github.com/s3gw-tech/s3gw-status#readme).) Check `create-s3tests-report.sh --help` for more information. diff --git a/mkdocs.yml b/mkdocs.yml index 167c8b73..b5ed3262 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,9 +1,9 @@ site_name: s3gw Project Documentation -repo_url: "https://github.com/aquarist-labs/s3gw" -repo_name: aquarist-labs/s3gw +repo_url: "https://github.com/s3gw-tech/s3gw" +repo_name: s3gw-tech/s3gw theme: name: material - logo: "https://raw.githubusercontent.com/aquarist-labs/s3gw/main/assets/images/s3gw-logo.png" + logo: "https://raw.githubusercontent.com/s3gw-tech/s3gw/main/assets/images/s3gw-logo.png" highlightjs: true features: - navigation.instant diff --git a/tools/s3tests/README.md b/tools/s3tests/README.md index 584dc784..6d3bf1f1 100644 --- a/tools/s3tests/README.md +++ b/tools/s3tests/README.md @@ -31,14 +31,14 @@ Integrated analysis tools: ## Container Images Live on GH in the [s3tr -container](https://github.com/aquarist-labs/s3gw/pkgs/container/s3tr) +container](https://github.com/s3gw-tech/s3gw/pkgs/container/s3tr) registry. Merging a PR triggers an action that builds and pushes a fresh image. ## Where do we use this? -- [PR CI pipeline](https://github.com/aquarist-labs/ceph/blob/s3gw/.github/workflows/test-s3gw.yml) +- [PR CI pipeline](https://github.com/s3gw-tech/s3gw-ceph/blob/s3gw/.github/workflows/test-s3gw.yml) - On a developer machine ## Where do the s3-tests come from? @@ -93,7 +93,7 @@ docker run \ docker run \ -v /var/run/docker.sock:/var/run/docker.sock \ -v $(readlink -f .):/out \ - ghcr.io/aquarist-labs/s3tr:latest \ + ghcr.io/s3gw-tech/s3tr:latest \ run \ --image ghcr.io/irq0/s3tr:latest \ --tests s3tests_boto3/functional/test_s3.py::test_copy_to_itself \ diff --git a/tools/s3tests/run_local_build_s3test.sh b/tools/s3tests/run_local_build_s3test.sh index 6494c81a..4270195f 100755 --- a/tools/s3tests/run_local_build_s3test.sh +++ b/tools/s3tests/run_local_build_s3test.sh @@ -75,7 +75,7 @@ fi docker run \ -v /var/run/docker.sock:/var/run/docker.sock \ -v "${OUTPUT_DIR}":/out \ - ghcr.io/aquarist-labs/s3tr:latest \ + ghcr.io/s3gw-tech/s3tr:latest \ run \ --docker-api unix://run/docker.sock \ --image docker.io/opensuse/tumbleweed:latest \ @@ -98,7 +98,7 @@ then docker run --rm \ -v "${OUTPUT_DIR}":/out \ -v "${CEPH_DIR}":/ceph:ro \ - ghcr.io/aquarist-labs/s3tr:latest \ + ghcr.io/s3gw-tech/s3tr:latest \ analyze summary \ /out/s3tr.json \ /ceph/qa/rgw/store/sfs/tests/fixtures/s3tr_excuses.csv