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

Create cluster configuration section and API docs section #236

Open
ry4nz opened this issue Nov 22, 2024 · 0 comments · May be fixed by #268
Open

Create cluster configuration section and API docs section #236

ry4nz opened this issue Nov 22, 2024 · 0 comments · May be fixed by #268
Assignees
Labels
Docs-A Must Do

Comments

@ry4nz
Copy link
Collaborator

ry4nz commented Nov 22, 2024

SME - @ranyodh

API - MkeConfig

In MKE3, configuration can be updated using the TOML config file which can be accessed from an API endpoints (/api/ucp/config-toml). To apply a change, a user can update this config file, and then upload it on the cluster at this endpoint: /api/ucp/config-toml

In MKE4, configuration is specified using a k8s custom resource named “MkeConfig”. It is a YAML file, with structure very similar to existing MKE3’s TOML file. To apply a change, a user can update MkeConfig, and then use mkectl apply -f .

API - HTTP API
MKE3 has a number of HTTP API endpoints to manage the cluster, manage users, tune etcd etc. Most of these APIs are not available in MKE4.0

In MKE4.0, following HTTP API is available:
Standard Kubernetes HTTP API (at /api and /apis)
User Management (add/edit/delete Users) at (/auth/users)
Prometheus metrics (at /api/v1/namespaces/mke/services/monitoring-kube-prometheus-prometheus:http-web/proxy/api/v1/query_range)

@KoryKessel-Mirantis KoryKessel-Mirantis added the Docs-A Must Do label Dec 11, 2024
@KoryKessel-Mirantis KoryKessel-Mirantis changed the title Document API changes Create cluster configuration section and API docs section Dec 17, 2024
@KoryKessel-Mirantis KoryKessel-Mirantis linked a pull request Dec 17, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs-A Must Do
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants