- Notifications
You must be signed in to change notification settings - Fork3
This repo contains a service that provides all APIs Sveltos dashboard uses
License
projectsveltos/ui-backend
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Please refere to sveltosdocumentation.
This repo contains a service that exposes all APIs used by Sveltos frontend.
Using authorization header is the only way to contact backend as an user, when accessing it over HTTP.To use authorization header you simply need to passAuthorization: Bearer <token> in every request.To create sample user and to get its token, seeCreating sample user guide.
/capiclusters
It is possible to filter by:
.namespace=<string> => returns only ClusterAPI powered clusters in a namespace whose name contains the speficied string
.name=<string> => returns only ClusterAPI powered clusters whose name contains the speficied string
.labels=<key1=value1,key2=value2> => returns only ClusterAPI powered clusters whose label matches the specified label selector
For instance:
http://localhost:9000/capiclusters?limit=1&skip=0&namespace=default&labels=env:fv,cluster.x-k8s.io%2Fcluster-name:clusterapi-workloadreturns
{"totalClusters":1,"managedClusters": [ {"namespace":"default","name":"clusterapi-workload","clusterInfo": {"labels": {"cluster.x-k8s.io/cluster-name":"clusterapi-workload","env":"fv","topology.cluster.x-k8s.io/owned":"" },"version":"v1.27.0","ready":true,"failureMessage":null } } ]}This API supports pagination. Use:
.limit=<int> to specify the number of ClusterAPI powered clusters the API will return
.skip=<int> to specify from which ClusterAPI powered cluster to start (Clusters are ordered by namespace/name)
/sveltosclusters
It is possible to filter by:
.namespace=<string> => returns only SveltosClusters in a namespace whose name contains the speficied string
.name=<string> => returns only SveltosClusters whose name contains the speficied string
.labels=<key1=value1,key2=value2> => returns only SveltosClusters whose label matches the specified label selector
For instance:
http://localhost:9000/sveltosclusters?limit=1&skip=0&namespace=mgmt&name=mgmtreturns
{"totalClusters":1,"managedClusters": [ {"namespace":"mgmt","name":"mgmt","clusterInfo": {"labels":null,"version":"v1.29.0","ready":true,"failureMessage":null } } ]}This API supports pagination. Use:
.limit=<int> to specify the number of SveltosClusters the API will return
.skip=<int> to specify from which SveltosClusters to start (Clusters are ordered by namespace/name)
/helmcharts?namespace=<namespace>&name=<cluster-name>&type=<cluster type>
where cluster type can either becapi for ClusterAPI powered clusters orsveltos for SveltosClusters
This API supports pagination. Use:
.limit=<int> to specify the number of helm releases the API will return
.skip=<int> to specify from which Helm release to start (Helm Releases are ordered by lastAppliedTime)
For instance:
http://localhost:9000/helmcharts?namespace=default&name=clusterapi-workload&type=capireturns
{"totalHelmReleases":4,"helmReleases": [ {"repoURL":"https://prometheus-community.github.io/helm-charts","releaseName":"prometheus","namespace":"prometheus","chartVersion":"23.4.0","icon":"https://raw.githubusercontent.com/prometheus/prometheus.github.io/master/assets/prometheus_logo-cb55bb5c346.png","lastAppliedTime":"2024-04-28T13:49:29Z","profileName":"ClusterProfile/prometheus-grafana" }, {"repoURL":"https://grafana.github.io/helm-charts","releaseName":"grafana","namespace":"grafana","chartVersion":"6.58.9","icon":"https://raw.githubusercontent.com/grafana/grafana/master/public/img/logo_transparent_400x.png","lastAppliedTime":"2024-04-28T13:49:38Z","profileName":"ClusterProfile/prometheus-grafana" }, {"repoURL":"https://kyverno.github.io/kyverno/","releaseName":"kyverno-latest","namespace":"kyverno","chartVersion":"3.1.4","icon":"https://github.com/kyverno/kyverno/raw/main/img/logo.png","lastAppliedTime":"2024-04-28T13:49:32Z","profileName":"ClusterProfile/deploy-kyverno" }, {"repoURL":"https://helm.nginx.com/stable/","releaseName":"nginx-latest","namespace":"nginx","chartVersion":"1.1.3","icon":"https://raw.githubusercontent.com/nginxinc/kubernetes-ingress/v3.4.3/charts/nginx-ingress/chart-icon.png","lastAppliedTime":"2024-04-28T13:49:36Z","profileName":"ClusterProfile/nginx" } ]}/resources?namespace=<namespace>&name=<cluster-name>&type=<cluster type>
where cluster type can either becapi for ClusterAPI powered clusters orsveltos for SveltosClusters
This API supports pagination. Use:
.limit=<int> to specify the number of Kubernetes resources the API will return
.skip=<int> to specify from which Kubernetes resources to start (Kubernetes resources are ordered by lastAppliedTime)
For instance:
http://localhost:9000/resources?namespace=default&name=clusterapi-workload&type=capireturns
{"totalResources":2,"resources": [ {"name":"nginx","group":"","kind":"Namespace","version":"v1","lastAppliedTime":"2024-04-28T13:52:26Z","profileNames": ["ClusterProfile/deploy-resources" ] }, {"name":"","group":"","kind":"","version":"","profileNames":null } ]}/getClusterStatus?namespace=<namespace>&name=<cluster-name>&type=<cluster-type>
where cluster type can either becapi for ClusterAPI powered clusters orsveltos for SveltosClusters
This API supports pagination. Use:
.limit=<int> to specify the number of Kubernetes resources the API will return
.skip=<int> to specify from which Kubernetes resources to start (Kubernetes resources are ordered by lastAppliedTime)
For instance:
http://localhost:9000/resources?namespace=default&name=clusterapi-workload&type=capireturns
{"profiles": [ {"profileName":"deploy-kyverno","profileType":"ClusterProfile","featureID":"Helm","status":"Provisioned" }, {"profileName":"deploy-resources","profileType":"ClusterProfile","featureID":"Resources","status":"Provisioned" }, {"profileName":"nginx","profileType":"ClusterProfile","featureID":"Helm","status":"Provisioned" } ],"totalResources":3}/profiles
It is possible to filter by:
.namespace=<string> => returns only Profiles in a namespace whose name contains the speficied string
.name=<string> => returns only ClusterProfiles/Profiles whose name contains the speficied string
returns all profiles grouped by tier.Each profile contains:
- Kind: kind of the profile (ClusterProfile vs Profile)
- Namespace: namespace of the profile (empty for ClusterProfiles)
- Name: name of the profile
- Dependencies: list of profiles the profile depends on
- Dependents: list of profiles that depend on this profile
'100':totalProfiles:4profiles: -kind:ClusterProfilenamespace:''name:deploy-kyvernodependencies:[]dependents: -kind:ClusterProfilename:prometheus-grafanaapiVersion:config.projectsveltos.io/v1beta1 -kind:ClusterProfilenamespace:''name:nginxdependencies:[]dependents:[] -kind:ClusterProfilenamespace:''name:prometheus-grafanadependencies: -kind:ClusterProfilename:deploy-kyvernoapiVersion:config.projectsveltos.io/v1beta1dependents:[] -kind:Profilenamespace:cokename:deploy-cert-managerdependencies:[]dependents:[]'200':totalProfiles:1profiles: -kind:ClusterProfilenamespace:''name:external-dnsdependencies:[]dependents:[]
/profile?namespace=<profile namespace>&name=<profile name>&kind=<profile kind>
Kind can either be:
- ClusterProfile
- Profile
ClusterProfiles are cluster wide resources. Profiles are namespaced resources. So namespace isonly required for Profile.
Response contains:
- Kind: kind of the profile (ClusterProfile vs Profile)
- Namespace: namespace of the profile (empty for ClusterProfiles)
- Name: name of the profile
- Dependencies: list of profiles the profile depends on
- Dependents: list of profiles that depend on this profile
- Spec: profile's spec
- MatchingClusters: list of clusters matching this profile. This list containsonly the clusters users has permission for. For each cluster, status of each feature (helm charts, raw yaml/json, kustomize)So if both coke and pepsi clusters are matching a profile, coke admin will only see coke clusters and pepsi admin will onlysee pepsi clusters. Platform admin will see both in the response.
matchingClusters:-cluster:kind:Clusternamespace:defaultname:clusterapi-workloadapiVersion:cluster.x-k8s.io/v1beta1clusterFeatureSummaries: -featureID:Resourcesstatus:Provisioned -featureID:Helmstatus:FailedNonRetriablefailureMessage:'cannot manage chart kyverno/kyverno-latest. ClusterSummary deploy-kyverno-capi-clusterapi-workload managing it.'spec:clusterSelector:matchLabels:env:fvsyncMode:Continuoustier:100stopMatchingBehavior:WithdrawPoliciesdependsOn: -deploy-kyvernopolicyRefs: -namespace:defaultname:disallow-latest-tagkind:ConfigMapdeploymentType:Remote -namespace:defaultname:disallow-empty-ingresskind:ConfigMapdeploymentType:RemotehelmCharts: -repositoryURL:https://kyverno.github.io/kyverno/repositoryName:kyvernochartName:kyverno/kyvernochartVersion:v3.2.6releaseName:kyverno-latestreleaseNamespace:kyvernohelmChartAction:Install
First, create a service account in the desired namespace:
kubectl create sa <user> -n <namespace>Give the service account permissions to access the Calico Enterprise Manager UI, and a Calico Enterprise cluster role:
kubectl create clusterrolebinding <binding_name> --clusterrole <role_name> --serviceaccount <namespace>:<service_account>where:
- binding_name is a descriptive name for the rolebinding.
- role_name is one of the default cluster roles (or a custom cluster role) specifying permissions.
- namespace is the service account's namespace.
- service_account is the service account that the permissions are being associated with.
Next, create a bearer token for the service account. Using the running example of a service account named, sveltos in thedefault namespace:
kubectl create token sveltos --duration=24hit should print somthing like
eyJhbGciOiJSUzI1NiIsImtpZCI6IkVsYW8zRU9BMWw3UTZ2QUpjNGFRLXljcTU4M1NhaXBZd1ZNWXJySkVtMTAifQ.eyJhdWQiOlsiaHR0cHM6Ly9rdWJlcm5ldGVzLmRlZmF1bHQuc3ZjLmNsdXN0ZXIubG9jYWwiXSwiZXhwIjoxNzI4NzE3NjA0LCJpYXQiOjE3Mjg2MzEyMDQsImlzcyI6Imh0dHBzOi8va3ViZXJuZXRlcy5kZWZhdWx0LnN2Yy5jbHVzdGVyLmxvY2FsIiwianRpIjoiZmQ1OWU4OTctODZlNS00MDQ4LWEwZjAtMDMxYjM5MjVlYjQwIiwia3ViZXJuZXRlcy5pbyI6eyJuYW1lc3BhY2UiOiJwbGF0Zm9ybSIsInNlcnZpY2VhY2NvdW50Ijp7Im5hbWUiOiJtZ2lhbmx1YyIsInVpZCI6ImJjZWUwZDEwLWM2MTQtNDIzNi1iNmZmLTAyYWU2M2M1MjcxZiJ9fSwibmJmIjoxNzI4NjMxMjA0LCJzdWIiOiJzeXN0ZW06c2VydmljZWFjY291bnQ6cGxhdGZvcm06bWdpYW5sdWMifQ.JlEN38Whyb4mlNsWkC4RAQ82dVUJmWvmdvar7VVxEw2SUgoQthQQPsV-l28bGYpuQspFlsdaO2JRdhm6MGctlMJziweHHm3PNv_RBnFMPRQ01y7ciaRZXE7HEB3sAndvBEQKNWyo4wmmyRnEE2tR79ICQRTLmuWO17MjRIZFChXMHsCsam5OsuE6mE1fj3RSUSbvfRbQwrsTcWOrnYxzquyNVyJyOKxQ97Nm175rez5x9EflHPwueYu5FmNgz3cxMsdkHwkrMnhMqMyNN8WBqKUrju-gPJ9GB-cOcrR_38JyeQBPXYTo9J0tueIWEyaiwKvmPqAsnyHKPT5p-7hFCQ❤️ Your contributions are always welcome! If you want to contribute, have questions, noticed any bug or want to get the latest project news, you can connect with us in the following ways:
- Open a bug/feature enhancement on github
- Chat with us on the Slack in the #projectsveltos channel
- Contact Us
Copyright 2022.
Licensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.
About
This repo contains a service that provides all APIs Sveltos dashboard uses