61ef119c1d
**Description**
<!--
Please include a summary of the change and which issue is fixed. Please
also include relevant motivation and context. List any dependencies that
are required for this change.
-->
This PR adds support for specifying a default S3 region when it cannot
be determined from the URL, or the underlying backup/restore solution
(or S3 server) does not support redirects to the correct region. See
Notes section for more information
⚒️ Fixes # <!--(issue)-->
**⚙️ Type of change**
- [X] ⚙️ Feature/App addition
- [ ] 🪛 Bugfix
- [ ] ⚠️ Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] 🔃 Refactor of current code
- [ ] 📜 Documentation Changes
**🧪 How Has This Been Tested?**
<!--
Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration
-->
What I have tested:
- Rendered a chart with credentials that specify the new region key
- Deployed the chart
- Observed CNPG backups succeeding (they were failing if I did not
specify the region). See notes for more information
- Observed Volsync backups succeeding
**📃 Notes:**
**Regarding the CNPG backups failiure:**
I am using a LAN IP address for the S3 backup endpoint. While Volsync
can work with just that, CNPG backups were failing. I am not 100% sure
what the underlying reason is. Still, from brief research on Google, I
suspect the reason CNPG fails and Volsync doesn't is because Volsync can
follow a redirect to the correct region by the S3 server, while CNPG's
barman cannot.
In the S3 server logs I see that CNPG tries to use `us-east-1` as the
region, which the server rejects.
I tried alternative solutions such as placing the region in the URL
path, however, that did not work. From the S3 server docs (which just
reference AWS S3 docs for the most part), I gather that a region can
only be specified in the URL as a subdomain - i.e.
`my-region.my-endpoint.com/my-bucket`. Since I am using a LAN IP to
connect to the server, I cannot specify a subdomain.
Adding the region in the CNPG config makes it "default" to the correct
region, and backup succeeds.
**Regarding CNPG's migration to the plugin-based barman**:
I know this project will need to migrate to the CNPG's new plugin-based
barman. However, as shown by the [migration
guide](https://cloudnative-pg.io/plugin-barman-cloud/docs/migration/#example),
similarly to my previous PRs (#40523, #40385), the `region` value can
just be migrated to the new `ObjectStore` CRD like so:
```yaml
...
barmanObjectStore:
endpointURL: ...
...
s3Credentials:
region:
name: secret-name
key: REGION
```
Migrates to:
```yaml
apiVersion: barmancloud.cnpg.io/v1
kind: ObjectStore
...
spec:
configuration:
endpointURL: ...
...
s3Credentials:
region:
name: secret-name
key: REGION
```
---
- [CNPG CRD for the region
key](31d5f7acab/config/crd/bases/postgresql.cnpg.io_clusters.yaml (L1258-L1271))
- [Restic docs for specifying a default
region](https://restic.readthedocs.io/en/stable/040_backup.html#environment-variables:~:text=AWS_DEFAULT_REGION%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20%20Amazon%20S3%20default%20region)
**✔️ Checklist:**
- [X] ⚖️ My code follows the style guidelines of this project
- [X] 👀 I have performed a self-review of my own code
- [X] #️⃣ I have commented my code, particularly in hard-to-understand
areas
- [ ] 📄 I have made changes to the documentation
- [X] 🧪 I have added tests to this description that prove my fix is
effective or that my feature works
- [X] ⬆️ I increased versions for any altered app according to semantic
versioning
- [X] I made sure the title starts with `feat(chart-name):`,
`fix(chart-name):`, `chore(chart-name):`, `docs(chart-name):` or
`fix(docs):`
**➕ App addition**
If this PR is an app addition please make sure you have done the
following.
- [ ] 🖼️ I have added an icon in the Chart's root directory called
`icon.png`
---
_Please don't blindly check all the boxes. Read them and only check
those that apply.
Those checkboxes are there for the reviewer to see what is this all
about and
the status of this PR with a quick glance._
title
| title |
|---|
| TrueCharts |
Community Helm Chart Catalog
TrueCharts is a catalog of highly optimised Helm Charts. Made for the community, by the community!
All our charts are supposed to work together and be easy to setup using any helm-compatible deployment tool, above all, give the average user more than enough options to tune things to their liking.
Getting started using TrueCharts
Support
Please check our FAQ, manual and Issue tracker There is a significant chance your issue has been reported before!
Still something not working as expected? Contact us! and we'll figure it out together!
Development
Our development process is fully distributed and agile, so every chart-maintainer is free to set their own roadmap and development speed and does not have to comply to a centralised roadmap. This ensures freedom and flexibility for everyone involved and makes sure you, the end user, always has the latest and greatest of every Chart installed.
Getting into creating Charts
For more information check the website: https://truecharts.org
Contact and Support
To contact the TrueCharts project:
-
Create an issue on Github issues
-
Open a Support Ticket
-
Send us an email
Contributors ✨
Thanks goes to these wonderful people (emoji key):
![renovate[bot]](https://avatars.githubusercontent.com/in/2740?v=4?s=100)
![allcontributors[bot]](https://avatars.githubusercontent.com/in/23186?v=4?s=100)
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4?s=100)
This project follows the all-contributors specification. Contributions of any kind welcome!
Licence
Truecharts, is primarily based on the AGPL-v3 license, this ensures almost everyone can use and modify our charts. Licences can vary on a per-Chart basis. This can easily be seen by the presence of a "LICENSE" file in that folder.
An exception to this, has been made for every document inside folders labeled as docs or doc and their subfolders: those folders are not licensed under AGPL-v3 and are considered "all rights reserved". Said content can be modified and changes submitted per PR, in accordance to the github End User License Agreement.
SPDX-License-Identifier: AGPL-3.0
