Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/projectsveltos/ui-backend

This repo contains a service that provides all APIs Sveltos dashboard uses
https://github.com/projectsveltos/ui-backend

Last synced: 4 months ago
JSON representation

This repo contains a service that provides all APIs Sveltos dashboard uses

Awesome Lists containing this project

README 

          
[![CI](https://github.com/projectsveltos/ui-backend/actions/workflows/main.yaml/badge.svg)](https://github.com/projectsveltos/ui-backend/actions)

[![Go Report Card](https://goreportcard.com/badge/github.com/projectsveltos/ui-backend)](https://goreportcard.com/report/github.com/projectsveltos/ui-backend)

[![Release](https://img.shields.io/github/v/release/projectsveltos/ui-backend)](https://github.com/projectsveltos/ui-backend/releases)

[![Slack](https://img.shields.io/badge/join%20slack-%23projectsveltos-brighteen)](https://join.slack.com/t/projectsveltos/shared_invite/zt-1hraownbr-W8NTs6LTimxLPB8Erj8Q6Q)

[![License](https://img.shields.io/badge/license-Apache-blue.svg)](LICENSE)

[![Twitter Follow](https://img.shields.io/twitter/follow/projectsveltos?style=social)](https://twitter.com/projectsveltos)






Please refere to sveltos [documentation](https://projectsveltos.github.io/sveltos/).



## What this repository is

This repo contains a service that exposes all APIs used by Sveltos frontend.



### Authorization Header



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 pass `Authorization: Bearer ` in every request.

To create sample user and to get its token, see [Creating sample user](#how-to-get-token) guide.



### Get ClusterAPI powered clusters



```/capiclusters```



It is possible to filter by:



. ```namespace=``` => returns only ClusterAPI powered clusters in a namespace whose name contains the speficied string



. ```name=``` => returns only ClusterAPI powered clusters whose name contains the speficied string



. ```labels=``` => 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-workload

```



returns



```json

{

  "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=``` to specify the number of ClusterAPI powered clusters the API will return



. ```skip=``` to specify from which ClusterAPI powered cluster to start (Clusters are ordered by namespace/name)



### Get SveltosClusters



```/sveltosclusters```



It is possible to filter by:



. ```namespace=``` => returns only SveltosClusters in a namespace whose name contains the speficied string



. ```name=``` => returns only SveltosClusters whose name contains the speficied string



. ```labels=``` => returns only SveltosClusters whose label matches the specified label selector



For instance:



```

http://localhost:9000/sveltosclusters?limit=1&skip=0&namespace=mgmt&name=mgmt

```



returns



```json

{

  "totalClusters": 1,

  "managedClusters": [

    {

      "namespace": "mgmt",

      "name": "mgmt",

      "clusterInfo": {

        "labels": null,

        "version": "v1.29.0",

        "ready": true,

        "failureMessage": null

      }

    }

  ]

}

```



This API supports pagination. Use:



. ```limit=``` to specify the number of SveltosClusters the API will return



. ```skip=``` to specify from which SveltosClusters to start (Clusters are ordered by namespace/name)



### Get Helm Releases deployed in a cluster



```/helmcharts?namespace=&name=&type=```



where cluster type can either be __capi__ for ClusterAPI powered clusters or __sveltos__ for SveltosClusters



It is also possible to filter helm charts by:



1. `release_namespace` => filter deployed helm charts by release namespace

2. `release_name` => filter deployed helm charts by release name



This API supports pagination. Use:



. ```limit=``` to specify the number of helm releases the API will return



. ```skip=``` 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=capi

```



returns



```json

{

  "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"

    }

  ]

}

```

### Get Kubernetes Resources deployed in a cluster



```/resources?namespace=&name=&type=```



where cluster type can either be __capi__ for ClusterAPI powered clusters or __sveltos__ for SveltosClusters



It is also possible to filter helm charts by:



1. `resource_namespace` => filter deployed resources by namespace

2. `resource_name` => filter deployed resources by name

2. `resource_kind` => filter deployed resources by kind



This API supports pagination. Use:



. ```limit=``` to specify the number of Kubernetes resources the API will return



. ```skip=``` 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=capi

```



returns



```json

{

  "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

    }

  ]

}

```



### Get Cluster Status



```/getClusterStatus?namespace=&name=&type=```



where cluster type can either be __capi__ for ClusterAPI powered clusters or __sveltos__ for SveltosClusters



It is also possible to filter helm charts by:



1. `profile_name` => filter profiles by name

2. `profile_kind` => filter profiles by kind



This API supports pagination. Use:



. ```limit=``` to specify the number of Kubernetes resources the API will return



. ```skip=``` 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=capi

```



returns



```json

{

  "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

}

```



### Get profiles



```/profiles```



It is possible to filter by:



. ```namespace=``` => returns only Profiles in a namespace whose name contains the speficied string



. ```name=``` => 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



```yaml

'100':

  totalProfiles: 4

  profiles:

  - kind: ClusterProfile

    namespace: ''

    name: deploy-kyverno

    dependencies: []

    dependents:

    - kind: ClusterProfile

      name: prometheus-grafana

      apiVersion: config.projectsveltos.io/v1beta1

  - kind: ClusterProfile

    namespace: ''

    name: nginx

    dependencies: []

    dependents: []

  - kind: ClusterProfile

    namespace: ''

    name: prometheus-grafana

    dependencies:

    - kind: ClusterProfile

      name: deploy-kyverno

      apiVersion: config.projectsveltos.io/v1beta1

    dependents: []

  - kind: Profile

    namespace: coke

    name: deploy-cert-manager

    dependencies: []

    dependents: []

'200':

  totalProfiles: 1

  profiles:

  - kind: ClusterProfile

    namespace: ''

    name: external-dns

    dependencies: []

    dependents: []

```



### Get a profile instance



```/profile?namespace=&name=&kind=```



Kind can either be:

- ClusterProfile

- Profile



ClusterProfiles are cluster wide resources. Profiles are namespaced resources. So namespace is *only* 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 contains *only* 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 only

see pepsi clusters. Platform admin will see both in the response.



```yaml

matchingClusters:

- cluster:

    kind: Cluster

    namespace: default

    name: clusterapi-workload

    apiVersion: cluster.x-k8s.io/v1beta1

  clusterFeatureSummaries:

  - featureID: Resources

    status: Provisioned

  - featureID: Helm

    status: FailedNonRetriable

    failureMessage: 'cannot manage chart kyverno/kyverno-latest. ClusterSummary deploy-kyverno-capi-clusterapi-workload

      managing it.'

spec:

  clusterSelector:

    matchLabels:

      env: fv

  syncMode: Continuous

  tier: 100

  stopMatchingBehavior: WithdrawPolicies

  dependsOn:

  - deploy-kyverno

  policyRefs:

  - namespace: default

    name: disallow-latest-tag

    kind: ConfigMap

    deploymentType: Remote

  - namespace: default

    name: disallow-empty-ingress

    kind: ConfigMap

    deploymentType: Remote

  helmCharts:

  - repositoryURL: https://kyverno.github.io/kyverno/

    repositoryName: kyverno

    chartName: kyverno/kyverno

    chartVersion: v3.2.6

    releaseName: kyverno-latest

    releaseNamespace: kyverno

    helmChartAction: Install

```



### Get list of EventTriggers



```/events```



This API supports pagination. Use:



. ```limit=``` to specify the number of Kubernetes resources the API will return



. ```skip=``` to specify from which Kubernetes resources to start (Kubernetes resources are ordered by lastAppliedTime)



```json

{"totalEvents":1,"eventTriggers":[{"name":"service-network-policy","matchingClusters":1}]}%

```



### Get EventTrigger Details



```event?name=```



Response contains:



- Name: name of the eventTrigger

- clusterSelector: eventTrigger's clusterSelector

- referenced EventSource

- MatchingClusters: list of clusters matching this profile. This list contains *only* the clusters users has permission for. For each cluster, list of resources matching the event



```json

{"eventTriggerName":"service-network-policy","clusterSelector":{"matchLabels":{"env":"fv"}},"eventSource":{"kind":"EventSource","apiVersion":"lib.projectsveltos.io/v1beta1","metadata":{"name":"sveltos-service"},"spec":{"resourceSelectors":[{"group":"","version":"v1","kind":"Service","labelFilters":[{"key":"sveltos","operation":"Equal","value":"fv"}]}],"collectResources":true}},"clusterEventMatches":[{"clusterNamespace":"default","clusterName":"clusterapi-workload","clusterKind":"Cluster","labels":{"cluster.x-k8s.io/cluster-name":"clusterapi-workload","env":"fv","sveltos-agent":"present","topology.cluster.x-k8s.io/owned":""},"version":"v1.35.0","ready":true,"paused":true,"failureMessage":null,"resources":[{"name":"my-service","namespace":"default","group":"","kind":"Service","version":"","profileNames":null}]}]}

```



### How to get token



First, create a service account in the desired namespace:



```

kubectl create sa  -n 

```



Give the service account permissions to access the Calico Enterprise Manager UI, and a Calico Enterprise cluster role:



```

kubectl create clusterrolebinding  --clusterrole  --serviceaccount :

```



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 the _default_ namespace:



```

kubectl create token sveltos --duration=24h

```



it should print somthing like



```

eyJhbGciOiJSUzI1NiIsImtpZCI6IkVsYW8zRU9BMWw3UTZ2QUpjNGFRLXljcTU4M1NhaXBZd1ZNWXJySkVtMTAifQ.eyJhdWQiOlsiaHR0cHM6Ly9rdWJlcm5ldGVzLmRlZmF1bHQuc3ZjLmNsdXN0ZXIubG9jYWwiXSwiZXhwIjoxNzI4NzE3NjA0LCJpYXQiOjE3Mjg2MzEyMDQsImlzcyI6Imh0dHBzOi8va3ViZXJuZXRlcy5kZWZhdWx0LnN2Yy5jbHVzdGVyLmxvY2FsIiwianRpIjoiZmQ1OWU4OTctODZlNS00MDQ4LWEwZjAtMDMxYjM5MjVlYjQwIiwia3ViZXJuZXRlcy5pbyI6eyJuYW1lc3BhY2UiOiJwbGF0Zm9ybSIsInNlcnZpY2VhY2NvdW50Ijp7Im5hbWUiOiJtZ2lhbmx1YyIsInVpZCI6ImJjZWUwZDEwLWM2MTQtNDIzNi1iNmZmLTAyYWU2M2M1MjcxZiJ9fSwibmJmIjoxNzI4NjMxMjA0LCJzdWIiOiJzeXN0ZW06c2VydmljZWFjY291bnQ6cGxhdGZvcm06bWdpYW5sdWMifQ.JlEN38Whyb4mlNsWkC4RAQ82dVUJmWvmdvar7VVxEw2SUgoQthQQPsV-l28bGYpuQspFlsdaO2JRdhm6MGctlMJziweHHm3PNv_RBnFMPRQ01y7ciaRZXE7HEB3sAndvBEQKNWyo4wmmyRnEE2tR79ICQRTLmuWO17MjRIZFChXMHsCsam5OsuE6mE1fj3RSUSbvfRbQwrsTcWOrnYxzquyNVyJyOKxQ97Nm175rez5x9EflHPwueYu5FmNgz3cxMsdkHwkrMnhMqMyNN8WBqKUrju-gPJ9GB-cOcrR_38JyeQBPXYTo9J0tueIWEyaiwKvmPqAsnyHKPT5p-7hFCQ

```



## Contributing



❤️ 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:



1. Open a bug/feature enhancement on github [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/projectsveltos/sveltos-manager/issues)

2. Chat with us on the Slack in the #projectsveltos channel [![Slack](https://img.shields.io/badge/join%20slack-%23projectsveltos-brighteen)](https://join.slack.com/t/projectsveltos/shared_invite/zt-1hraownbr-W8NTs6LTimxLPB8Erj8Q6Q)

3. [Contact Us](mailto:support@projectsveltos.io)



## License



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.0



Unless required by applicable law or agreed to in writing, software

distributed 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 and

limitations under the License.