Skip to content

Commit

Permalink
s3gw: replace 'aquarist-labs' with 's3gw-tech'
Browse files Browse the repository at this point in the history
Not everywhere though. All existing decisions under 'docs/decisions'
have been kept in their original form.

Signed-off-by: Joao Eduardo Luis <[email protected]>
  • Loading branch information
jecluis committed Mar 16, 2024
1 parent 3c0f602 commit ddb708a
Show file tree
Hide file tree
Showing 18 changed files with 82 additions and 83 deletions.
1 change: 0 additions & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
The 5 repositories used for the s3gw are located within our main GitHub
organization.

- Main: <https://github.com/aquarist-labs/s3gw>
- Ceph: <https://github.com/aquarist-labs/ceph>
- UI: <https://github.com/aquarist-labs/s3gw-ui>
- Charts: <https://github.com/aquarist-labs/s3gw-charts>
- COSI: <https://github.com/aquarist-labs/s3gw-cosi-driver>
- Main: <https://github.com/s3gw-tech/s3gw>
- Ceph: <https://github.com/s3gw-tech/ceph>
- UI: <https://github.com/s3gw-tech/s3gw-ui>
- Charts: <https://github.com/s3gw-tech/s3gw-charts>
- COSI: <https://github.com/s3gw-tech/s3gw-cosi-driver>

We welcome new feature implementations, patches that fix bugs or code cleanup.

Expand All @@ -16,15 +16,15 @@ 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.

### 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
Expand Down Expand Up @@ -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 <[email protected]>
```
Expand All @@ -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
Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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/
4 changes: 2 additions & 2 deletions docs/config-s3gw.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion docs/contributing.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!-- markdownlint-disable MD013 -->
<!-- markdownlint-disable MD041 -->
{{ external_markdown('https://raw.githubusercontent.com/aquarist-labs/s3gw/main/CONTRIBUTING.md', '') }}
{{ external_markdown('https://raw.githubusercontent.com/s3gw-tech/s3gw/main/CONTRIBUTING.md', '') }}
2 changes: 1 addition & 1 deletion docs/decisions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
6 changes: 3 additions & 3 deletions docs/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down Expand Up @@ -88,8 +88,8 @@ against the running RGW. E.g., `s3cmd mb s3://foo`, to create a new bucket.

<!--- Probably should think about some troubleshooting docs for the above (A.S) -->

[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

Expand Down
4 changes: 2 additions & 2 deletions docs/helm-charts.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand All @@ -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).
2 changes: 1 addition & 1 deletion docs/ideas/PID-0-reserved.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 4 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
4 changes: 2 additions & 2 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://aquarist-labs.github.io/s3gw-charts/> and the main branch.
<https://s3gw-tech.github.io/s3gw-charts/> and the main branch.
- Apps -> Charts -> Install Traefik.
- Apps -> Charts -> Install `s3gw`.
Select the `s3gw` namespace previously created.
Expand All @@ -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
10 changes: 5 additions & 5 deletions docs/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
54 changes: 27 additions & 27 deletions docs/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
10 changes: 5 additions & 5 deletions docs/s3gw-repos.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

The S3 Gateway includes the following projects:

- aquarist-labs/s3gw <https://github.com/aquarist-labs/s3gw>
- aquarist-labs/ceph <https://github.com/aquarist-labs/ceph>
- aquarist-labs/s3gw-charts <https://github.com/aquarist-labs/s3gw-charts>
- aquarist-labs/s3gw-status <https://github.com/aquarist-labs/s3gw-status>
- aquarist-labs/s3gw-cosi-driver <https://github.com/aquarist-labs/s3gw-cosi-driver>
- s3gw-tech/s3gw <https://github.com/s3gw-tech/s3gw>
- s3gw-tech/s3gw-ceph <https://github.com/s3gw-tech/s3gw-ceph>
- s3gw-tech/s3gw-charts <https://github.com/s3gw-tech/s3gw-charts>
- s3gw-tech/s3gw-status <https://github.com/s3gw-tech/s3gw-status>
- s3gw-tech/s3gw-cosi-driver <https://github.com/s3gw-tech/s3gw-cosi-driver>
4 changes: 2 additions & 2 deletions docs/testing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 3 additions & 3 deletions tools/s3tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down Expand Up @@ -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 \
Expand Down
4 changes: 2 additions & 2 deletions tools/s3tests/run_local_build_s3test.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand All @@ -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
Expand Down

0 comments on commit ddb708a

Please sign in to comment.