Skip to content

Commit

Permalink
ENG-12957: Add section for S3 File Browser configuration (#7)
Browse files Browse the repository at this point in the history
* Add section for S3 File Browser configuration

* Move s3 documentation to /docs directory

* Fix reference to values-file.md

* Fix order of itens in Advanced section

* Update docs/s3-browser.md

Co-authored-by: Wilson de Carvalho <796900+wcmjunior@users.noreply.github.com>

---------

Co-authored-by: Wilson de Carvalho <796900+wcmjunior@users.noreply.github.com>
  • Loading branch information
VictorGFM and wcmjunior authored Mar 12, 2024
1 parent ea9efc4 commit 39f6ca9
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,7 @@ Learn more in the [sidecar upgrade procedures](https://cyral.com/docs/sidecars/m

Instructions for advanced configurations are available for the following topics:

* [Enable the S3 File Browser](./docs/s3-browser.md)
* [Expose to the Internet](./docs/public-load-balancer.md)
* [Node scheduling](./docs/node-scheduling.md)
* [Restrict repositories' ports](./docs/port-configuration.md)
Expand Down
21 changes: 21 additions & 0 deletions docs/s3-browser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
#### Enable the S3 File Browser

To configure the sidecar to work on the S3 File Browser, set the following extra parameters under the service key of your values file:

```
service:
dnsName: "<CNAME>" # ex: "sidecar.custom-domain.com"
loadBalancer:
tlsPorts: [443]
certificateId: "arn:aws:acm:<REGION>:<AWS_ACCOUNT>:certificate/<CERTIFICATE_ID>"
```

The CNAME provided in `service.dnsName` must be created
after the deployment pointing to the sidecar load balancer.
See [Add a CNAME or A record for the sidecar](https://cyral.com/docs/sidecars/manage/alias).

All the Helm parameters used above are documented in the
[values file configuration reference](./values-file.md).
For more details about the S3 File Browser configuration, check the
[Enable the S3 File Browser](https://cyral.com/docs/how-to/enable-s3-browser)
documentation.

0 comments on commit 39f6ca9

Please sign in to comment.