Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
steveteuber committed Nov 25, 2021
1 parent 039103c commit 873b534
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<details>
<summary><strong>Graphviz</strong></summary><br>

The *default* output format requires `dot` to convert the output into a useful format.

```
brew install graphviz
```
</details>

### Neo4j
<details>
<summary><strong>Neo4j</strong></summary><br>

The *CQL* output format requires `cypher-shell` to connect to a Neo4j database.

```
brew install cypher-shell
```
</details>

### ArangoDB
<details>
<summary><strong>ArangoDB</strong></summary><br>

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
```
</details>

## Installation

Expand All @@ -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
Expand Down

0 comments on commit 873b534

Please sign in to comment.