https://github.com/g-harel/sekstant

graphql interface for the kubernetes api
https://github.com/g-harel/sekstant

graphiql graphql kubernetes

Last synced: about 2 months ago
JSON representation

graphql interface for the kubernetes api

• Host: GitHub
• URL: https://github.com/g-harel/sekstant
• Owner: g-harel
• License: mit
• Created: 2018-07-31T02:39:59.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-10-26T16:37:46.000Z (about 5 years ago)
• Last Synced: 2024-11-13T04:52:15.214Z (about 2 months ago)
• Topics: graphiql, graphql, kubernetes
• Language: JavaScript
• Homepage:
• Size: 18.6 KB
• Stars: 52
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![image](https://user-images.githubusercontent.com/9319710/54000904-463d8180-4117-11e9-9bb2-09e023a7e66c.png)

# sekstant

GraphQL interface for the Kubernetes API.

```yaml

apiVersion: v1

kind: Pod

metadata:

  name: sekstant

spec:

  containers:

  - name: sekstant

    image: gcr.io/sekstant/sekstant

    ports:

    - containerPort: 11456

```

The image expects to run inside a [Kubernetes](https://kubernetes.io/) cluster. On startup, it queries the API server for its [Swagger specification](https://swagger.io/specification/) and translates it into a [GraphQL](https://graphql.org/) schema which is then exposed as an HTTP endpoint.

_[Custom resource definitions may be supported in the future.](https://github.com/kubernetes/enhancements/issues/692)_

## Options

`PORT` Container port used to expose the GraphQL api (default `11456`)

`PATHNAME` URL path at which GraphQL API is exposed (default `/graphql`)

`GRAPHIQL` Configuration to enable the [GraphiQL IDE](https://github.com/graphql/graphiql) (default `disabled`)

#### Authorization

Authorization is inherited from the pod's service account credentials read from the [container's filesystem](https://kubernetes.io/docs/tasks/access-application-cluster/access-cluster/#accessing-the-api-from-a-pod). The following options allow configuration of this behavior.

_[Example service account and RBAC configuration.](./example.yaml)_

`API_SERVER_URL` Base URL of the API server (default `https://kubernetes.default.svc`)

`TOKEN_PATH` Path to the pod's service account token (default `/var/run/secrets/kubernetes.io/serviceaccount/token`)

`CERTIFICATE_PATH` Path to the API server's certificate (default `/var/run/secrets/kubernetes.io/serviceaccount/ca.crt`)

_[You may need to enable RBAC explicitly when using minikube.](https://gist.github.com/F21/08bfc2e3592bed1e931ec40b8d2ab6f5)_

## License

[MIT](./LICENSE)