Converts README from rst to markdown

This commit is contained in:
Elia el Lazkani 2021-03-20 11:52:35 +01:00
parent d687562608
commit 6b27cc413b

View file

@ -1,19 +1,18 @@
Get K8s Resources
=================
---
title: 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
-----
::
# 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
@ -25,14 +24,12 @@ Usage
--kubeconfig KUBECONFIG
path to the kubeconfig
```
Requirements
------------
# Requirements
The requirements can be found in the `requirements.txt` file in this repository.
The requirements can be found in the [requirements.txt](../src/branch/master/requirements.txt) file in this repository.
Configuration
-------------
By default, this tool will try to find your kubeconfig in the default paths where `kubectl` 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.
# 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.