astro-stan
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](https://github.com/cloudnative-pg/cloudnative-pg/blob/31d5f7acabd75e4b7fdc3ebe61c2cbf9c404f8b1/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 |
|---|
| README |
General Info
For more information about this Chart, please check the docs on the TrueCharts website
This chart is not maintained by the upstream project and any issues with the chart should be raised here
Installation
Helm-Chart installation
To install TrueCharts Helm charts using Helm, you can use our OCI Repository.
helm install mychart oci://oci.trueforge.org/truecharts/common
For more information on how to install TrueCharts Helm charts, checkout the instructions on the website
Chart Specific Guides and information
All our charts have dedicated documentation pages. The documentation for this chart can be found here: https://trueforge.org/truecharts/library/common
Configuration Options
To view the chart specific options, please view Values.yaml included in the chart. The most recent version of which, is available here: https://github.com/trueforge-org/truecharts/blob/master/charts/library/common/values.yaml
All our Charts use a shared "common" library chart that contains most of the templating and options. For the complete overview of all available options, please checkout the documentation for them on the common docs on our website
For information about the common chart and all defaults included with it, please review its values.yaml file available here: https://github.com/trueforge-org/truecharts/blob/master/charts/library/common/values.yaml
Support
Sponsor TrueCharts
TrueCharts can only exist due to the incredible effort of our staff. Please consider making a donation or contributing back to the project any way you can!
All Rights Reserved - The TrueCharts Project