Skip to content

Commit

Permalink
Updated discovery-manager README
Browse files Browse the repository at this point in the history
  • Loading branch information
devdattakulkarni committed Nov 16, 2018
1 parent 565b50d commit 468f5d7
Showing 1 changed file with 9 additions and 13 deletions.
22 changes: 9 additions & 13 deletions discovery-manager/README.rst
Expand Up @@ -4,32 +4,28 @@ Discovery Manager

Component of KubePlus that enables discovering static and dynamic information about Custom Resources.

Discovery Manager is a Kubernetes Aggregated API Server that registers two custom endpoints: /explain and /describe
This directory is just a place-holder directory. Actual Discovery Manager code is in kubediscovery_ repository.

.. _kubediscovery: https://github.com/cloud-ark/kubediscovery

You can pass query parameters to these to find out information about Custom Resource.

Discovery Manager is a Kubernetes Aggregated API Server that registers two custom endpoints: /explain and /composition. You can pass query parameters to these to find out information about Custom Resources.

Example:

Find out details about a Custom Resource's Spec definition:

``$ kubectl get --raw "/apis/kubediscovery.cloudark.io/v1/explain?cr=Postgres"``
``$ kubectl get --raw "/apis/kubediscovery.cloudark.io/v1/explain?kind=Postgres"``


Find out dynamic composition tree for Postgres custom resource instance:

``$ kubectl get --raw "/apis/kubediscovery.cloudark.io/v1/describe?cr=Postgres&instance=postgres1" | python -mjson.tool``
``$ kubectl get --raw "/apis/kubediscovery.cloudark.io/v1/composition?kind=Postgres&instance=postgres1" | python -mjson.tool``


**Note:**

This interface of ``kubectl get --raw`` will not be needed once ``kubectl describe`` and ``kubectl explain`` start
supporting custom resources.
The interface of ``kubectl get --raw`` for explain will not be needed once upstream ``kubectl explain``
starts supporting custom resources.

We plan to contribute kubediscovery_ code upstream towards this.


Check README from kubeplus repository for detailed example.

This directory is just a place-holder directory. Actual Discovery Manager code is in kubediscovery_ repository.

.. _kubediscovery: https://github.com/cloud-ark/kubediscovery

0 comments on commit 468f5d7

Please sign in to comment.