Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Enhancement Proposal] Add more documentation #49

Open
michaeldmitry opened this issue Sep 6, 2024 · 1 comment
Open

[Enhancement Proposal] Add more documentation #49

michaeldmitry opened this issue Sep 6, 2024 · 1 comment
Labels
bug Something isn't working

Comments

@michaeldmitry
Copy link

michaeldmitry commented Sep 6, 2024

Steps to reproduce

  1. Open https://charmhub.io/s3-integrator

Expected behavior

I think the documentation does a good job in explaining, by giving examples, how to set S3 config options using the juju config s3-integrator bucket=.... on the provider side. But, there's an option to pass the bucket name from the requirer side. I think it would be very useful to add to the charm documentation the below points to cover:

1- How to set bucket names from requirer side? When to use that? What'd happen if we set both the provider and the requirer side?
2- How should the s3-integrator be deployed in a cluster where multiple charms want to use the s3 integrator with different bucket names/config? Should it be a one S3 integrator per charm or could we integrate all charms to one s3 integrator app?
3- What are some of the added benefits of using s3-integrator instead of relating a charm directly to an s3-like charm?

Actual behavior

N/A

Versions

N/A

Log output

N/A

Additional context

N/A

@michaeldmitry michaeldmitry added the bug Something isn't working label Sep 6, 2024
Copy link

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/DPE-5390.

This message was autogenerated

@michaeldmitry michaeldmitry changed the title [Enhancement Proposal] Add more documentation on other ways to use S3 integrator [Enhancement Proposal] Add more documentation on how to use S3 integrator Sep 6, 2024
@michaeldmitry michaeldmitry changed the title [Enhancement Proposal] Add more documentation on how to use S3 integrator [Enhancement Proposal] Add more documentation Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant