From 873b534fda6ec17d7030f295a396781562be535b Mon Sep 17 00:00:00 2001 From: Steve Teuber Date: Thu, 25 Nov 2021 12:29:23 +0100 Subject: [PATCH] Update README.md --- README.md | 28 +++++++++++++++++----------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 9f6d9a1..a0f07ff 100644 --- a/README.md +++ b/README.md @@ -13,29 +13,35 @@ A kubectl plugin to visualize Kubernetes resources and relationships. This plugin requires [Graphviz](https://graphviz.org), [Neo4j](https://neo4j.com) *or* [ArangoDB](https://www.arangodb.com) to visualize the dependency graph. -### Graphviz +
+Graphviz
The *default* output format requires `dot` to convert the output into a useful format. ``` brew install graphviz ``` +
-### Neo4j +
+Neo4j
The *CQL* output format requires `cypher-shell` to connect to a Neo4j database. ``` brew install cypher-shell ``` +
-### ArangoDB +
+ArangoDB
-The *AQL* output format requires `curl` to send API requests to an ArangoDB server. +The *AQL* output format requires `curl` and `jq` to send API requests to an ArangoDB server. ``` -brew install curl +brew install curl jq ``` +
## Installation @@ -45,19 +51,19 @@ This `kubectl` plugin is distributed via [krew](https://krew.sigs.k8s.io). To in kubectl krew install graph ``` -## Quickstart - -This quickstart guide uses macOS. It's possible that the commands can differ on other operating systems. - -### Usage +## Usage In general, this plugin is working like `kubectl get` but it tries to resolve relationships between the Kubernetes resources before it prints a graph in `AQL`, `CQL` *or* `DOT` format. By default, the plugin will use `DOT` as output format. ``` -kubectl graph [(-o|--output=)cql|cypher|dot|graphviz] (TYPE[.VERSION][.GROUP] ...) [flags] +kubectl graph [(-o|--output=)aql|arangodb|cql|cypher|dot|graphviz] (TYPE[.VERSION][.GROUP] ...) [flags] ``` +## Quickstart + +This quickstart guide uses macOS. It's possible that the commands can differ on other operating systems. + ### Graphviz When you have installed the `dot` command line tool, then you can start to fetch all running Pods in the