get-k8s-resources/README.md

# Get K8s Resources

The `get_k8s_resources` script is a small script that will return a list of all instances of a certain kubernetes type `JSON` formatted.

## Usage

``` text
    $ get-k8s-resources -h
    usage: get-k8s-resources [-h] [-n NAMESPACE] [-c CONTEXT] -t
                                {deployments,services,pods,ingresses}

    Returns a json list of kubernetes deployments.

    optional arguments:
      -h, --help            show this help message and exit
      -n NAMESPACE, --namespace NAMESPACE
                            filter by namespace
      -c CONTEXT, --context CONTEXT
                            context to use
      -t {deployments,services,pods,ingresses}, --type {deployments,services,pods,ingresses}
                            type of kubernetes resource to get
      --kubeconfig KUBECONFIG
                            path to the kubeconfig

```

## Requirements

The requirements can be found in the [requirements.txt](requirements.txt) file in this repository.

## Configuration

By default, this tool will try to find your kubeconfig in the default paths where [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) looks for. It will also try to take assumptions on which `context` it should be using if there are multiple contexts in the same configuration. Generally, it should work as shown in the help menu.
Updates README 2021-03-20 10:54:32 +00:00			`# Get K8s Resources`
Second commit 2019-03-07 23:41:45 +00:00
Reformatting code and formatting output to JSON 2019-03-10 01:59:19 +00:00			The `get_k8s_resources` script is a small script that will return a list of all instances of a certain kubernetes type `JSON` formatted.
Second commit 2019-03-07 23:41:45 +00:00
Formats README.md 2021-03-20 10:55:21 +00:00			`## Usage`
Of course it's an empty line that matters 2019-03-07 23:47:03 +00:00
Converts README from rst to markdown 2021-03-20 10:52:35 +00:00			``` text
Fixing README 2019-03-07 23:43:13 +00:00			`$ get-k8s-resources -h`
Reformatting code to make it simpler 2019-03-08 00:05:31 +00:00			`usage: get-k8s-resources [-h] [-n NAMESPACE] [-c CONTEXT] -t`
Fixing README 2019-03-07 23:43:13 +00:00			`{deployments,services,pods,ingresses}`
Converts README from rst to markdown 2021-03-20 10:52:35 +00:00
Fixing README 2019-03-07 23:43:13 +00:00			`Returns a json list of kubernetes deployments.`
Converts README from rst to markdown 2021-03-20 10:52:35 +00:00
Fixing README 2019-03-07 23:43:13 +00:00			`optional arguments:`
			`-h, --help show this help message and exit`
			`-n NAMESPACE, --namespace NAMESPACE`
			`filter by namespace`
			`-c CONTEXT, --context CONTEXT`
			`context to use`
			`-t {deployments,services,pods,ingresses}, --type {deployments,services,pods,ingresses}`
			`type of kubernetes resource to get`
			`--kubeconfig KUBECONFIG`
			`path to the kubeconfig`
Second commit 2019-03-07 23:41:45 +00:00
Converts README from rst to markdown 2021-03-20 10:52:35 +00:00			```
Second commit 2019-03-07 23:41:45 +00:00
Formats README.md 2021-03-20 10:55:21 +00:00			`## Requirements`
Second commit 2019-03-07 23:41:45 +00:00
Updates README 2021-03-20 10:54:32 +00:00			`The requirements can be found in the [requirements.txt](requirements.txt) file in this repository.`
Second commit 2019-03-07 23:41:45 +00:00
Formats README.md 2021-03-20 10:55:21 +00:00			`## Configuration`
Second commit 2019-03-07 23:41:45 +00:00
Converts README from rst to markdown 2021-03-20 10:52:35 +00:00			By default, this tool will try to find your kubeconfig in the default paths where [kubectl](https://kubernetes.io/docs/reference/kubectl/overview/) looks for. It will also try to take assumptions on which `context` it should be using if there are multiple contexts in the same configuration. Generally, it should work as shown in the help menu.