Skip to content

Clarify MinIO development settings #8090

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

Closed
astrojuanlu opened this issue Apr 12, 2021 · 4 comments
Closed

Clarify MinIO development settings #8090

astrojuanlu opened this issue Apr 12, 2021 · 4 comments
Assignees
Labels
Needed: documentation Documentation is required

Comments

@astrojuanlu
Copy link
Contributor

In #8082 (comment), @cocobennett followed the steps to configure MinIO for local development and still ended up with an incomplete environment. In fact, I had made the same mistake two weeks early when I just joined the company. @stsewd clarified later, but this should be present in the docs.

In particular, I think we should replace this:

https://github.com/readthedocs/readthedocs.org/blame/eb682d8b8f480e96e7478d968aa12e52f4118063/docs/development/install.rst#L66-L71

by something that doesn't assume that the user knows how MinIO works.

@astrojuanlu
Copy link
Contributor Author

Also, instead of waiting for the first build to create the media bucket, we can either create it manually or automate it on init somehow. What do you think @stsewd @humitos?

@humitos
Copy link
Member

humitos commented Apr 12, 2021

instead of waiting for the first build to create the media bucket, we can either create it manually or automate it on init somehow

Yes. This is something we want to do. We used to do this when using Azurite (Azure Blob Storage emulator) but when we migrated to S3 we removed this because the bucket were automatically created on the first usage. However, that won't be true anymore when we upgrade django-storages. See readthedocs/common#80 (comment)

Summarizing, we want that feature back 😄

@stsewd stsewd added the Needed: documentation Documentation is required label Apr 12, 2021
@astrojuanlu astrojuanlu self-assigned this Apr 19, 2021
@astrojuanlu
Copy link
Contributor Author

I opened #8113 to address this and other related doc improvements. However, I did not address the automatic creation of the media bucket (quickly tried locating the old create_container.sh without success).

@humitos
Copy link
Member

humitos commented Apr 19, 2021

However, I did not address the automatic creation of the media bucket (quickly tried locating the old create_container.sh without success).

This is the script I'm referring to https://github.com/readthedocs/common/blob/7c126c3ffa8a0314e92b3a026bcb73c1f1ba8526/dockerfiles/scripts/create-containers.sh

However, that script was done for Azurite Blob Storage (it uses the az command). The idea is exactly the same, but we will need to use AWS CLI instead. I may not be that easy 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

3 participants