Kubernetes quartermaster

Effectively obtain kubernetes resources
Explore the packege »

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap

About The Project

This package allows you to navigate the Open API specification of the kubernetes api to find details on kubernetes resources.

(back to top)

Getting Started

These are mainly development related instructions. They also serve as a placeholder for future README updates.

Prerequisites

During development you need to update dependencies using the following command.

go mod tidy

Installation

To test the application run the following command, this will run the main function in main.go which can be used to debug.

go run .

Documentation

GoDoc is supproted, after you have installed it use the following command to view the documentation on your localhost:8080.

godoc -http=:8080

(back to top)

Usage

For usage explore the GoDoc documentation.

(back to top)

Roadmap

• Add kinds function
• Add parameter function
  • level 1
  • recursive
• Update README
• Where to publish documentation

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contact

Rik van Brakel - rik.van.brakel@sue.nl

Project Link: https://github.com/Brikkel/k8s-api-spec

(back to top)