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.

Sign up for GitHub

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

Jump to bottom

Document readiness endpoint #1188

Closed
3 tasks done
ravindk89 opened this issue Apr 17, 2024 · 2 comments · Fixed by #1221
Closed
3 tasks done

Document readiness endpoint #1188

ravindk89 opened this issue Apr 17, 2024 · 2 comments · Fixed by #1221
Assignees
@djwfyi
Labels
tiny Small, bite-sized fixes that require minimal effort

Comments

@ravindk89
Copy link
Collaborator

ravindk89 commented Apr 17, 2024 •
edited by djwfyi

Summary

We need to document both mc ready and its corresponding API endpoint /minio/health/ready

Goals

List the in-scope goals

  • Document the new APIs
  • Clarify their usage vs the existing health/liveness endpoints
  • Figure out when they were added (Optional)
@djwfyi
Copy link
Collaborator

djwfyi commented Apr 17, 2024

mc ready was added in this PR from July 2022.
minio/mc#4101

Which was included in mc RELEASE.2022-07-06T14-54-36Z.

@ravindk89 ravindk89 added the tiny Small, bite-sized fixes that require minimal effort label May 13, 2024
@djwfyi djwfyi self-assigned this May 21, 2024
@djwfyi
Copy link
Collaborator

djwfyi commented May 21, 2024

Readiness API is already documented at https://min.io/docs/minio/linux/operations/monitoring/healthcheck-probe.html.
Not adding the normal version add reference, as the command has been in for just about two years at this point.

djwfyi added a commit that referenced this issue May 21, 2024
@djwfyi
Adds mc ready to reference docs
7e8aad6 
Closes #1188
@djwfyi djwfyi mentioned this issue May 21, 2024
Merged
djwfyi added a commit that referenced this issue May 22, 2024
@djwfyi
Adds mc ready to reference docs (#1221)
c1bbe71 
Closes #1188
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@djwfyi djwfyi

Labels
tiny Small, bite-sized fixes that require minimal effort
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Adds mc ready to reference docs minio/docs
2 participants
@ravindk89 @djwfyi