62 lines
2.1 KiB
Markdown
62 lines
2.1 KiB
Markdown
# [s3gw][s3gw-url]
|
||
|
||
s3gw is an S3-compatible service focused on deployments in a Kubernetes
|
||
environment backed by any PVC, including Longhorn. Since its inception, the
|
||
primary focus has been on cloud native deployments. However, the s3gw can be
|
||
deployed in a myriad of scenarios, provided some form of storage is attached.
|
||
|
||
s3gw is based on Ceph’s RADOSGW (RGW) but runs as a stand–alone service without
|
||
the RADOS cluster and relies on a storage backend still under heavy development
|
||
by the storage team at SUSE. A web-based UI for management and an object
|
||
explorer are also part of s3gw.
|
||
|
||
## Quickstart
|
||
|
||
To install s3gw using Helm add the chart to your Helm repository and then run
|
||
`helm install`:
|
||
|
||
```bash
|
||
helm add repo s3gw https://aquarist-labs.github.io/s3gw-charts/
|
||
helm \
|
||
--namespace s3gw-system \
|
||
install s3gw \
|
||
s3gw/s3gw \
|
||
--create-namespace \
|
||
-f /path/to/your/custom/values.yaml
|
||
```
|
||
|
||
## Rancher
|
||
|
||
Installing s3gw via the Rancher App Catalog is made easy, the steps are as
|
||
follows:
|
||
|
||
- Cluster -> Projects/Namespaces - create the `s3gw` namespace.
|
||
- Apps -> Repositories -> Create `s3gw` using the s3gw-charts Git URL
|
||
<https://aquarist-labs.github.io/s3gw-charts/> and the `main` branch.
|
||
- Apps -> Charts -> Install `Traefik`.
|
||
- Apps -> Charts -> Install `s3gw`. Select the `s3gw` namespace previously
|
||
created. A `pvc` for `s3gw` will be created automatically during installation.
|
||
|
||
## Documentation
|
||
|
||
You can access our documentation [here][docs-url].
|
||
|
||
## License
|
||
|
||
Licensed under the Apache License, Version 2.0 (the "License");
|
||
you may not use licensed files except in compliance with the License.
|
||
You may obtain a copy of the License at
|
||
|
||
<http://www.apache.org/licenses/LICENSE-2.0>
|
||
|
||
or the LICENSE file in this repository.
|
||
|
||
Unless required by applicable law or agreed to in writing, software
|
||
distributed under the License is distributed on an "AS IS" BASIS,
|
||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||
See the License for the specific language governing permissions and
|
||
limitations under the License.
|
||
|
||
[s3gw-url]: https://s3gw.io
|
||
[docs-url]: https://s3gw-docs.readthedocs.io/en/latest/helm-charts/
|