Skip to content

Commit

Permalink
added menu links
Browse files Browse the repository at this point in the history
  • Loading branch information
Abhinav-26 committed Jul 24, 2023
1 parent e096f4d commit 3e488b6
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@
<p align="center">
ApiVersion Compatibility Checker & Provides Migration Path for K8s Objects
<br />
<a href="#motivation"><strong>Motivation</strong></a>
<a href="#bulb-motivation"><strong>Motivation</strong></a>
|
<a href="#getting-started"><strong>Getting Started</strong></a>
<a href="#rocket-getting-started"><strong>Getting Started</strong></a>
|
<a href="#usage"><strong>Usage</strong></a>
<a href="#gear-usage"><strong>Usage</strong></a>
|
<a href="#output"><strong>Output</strong></a>
<a href="#file_folder-output"><strong>Output</strong></a>
<br />
<a href="https://github.com/devtron-labs/silver-surfer/issues/new">Report Bug</a>
|
<a href="https://github.com/devtron-labs/silver-surfer/issues/new">Request Feature</a>
|
<a href="#contribute">Support</a>
<a href="#handshake-contribute">Support</a>

<a href="https://discord.gg/jsRG5qx2gp"><img src="https://img.shields.io/badge/Join%20us%20on-Discord-e01563.svg" alt="Join Discord"></a>
<a href="https://goreportcard.com/badge/github.com/devtron-labs/devtron"><img src="https://goreportcard.com/badge/github.com/devtron-labs/devtron" alt="Go Report Card"></a>
Expand All @@ -33,7 +33,7 @@
</p>
</div>

## Motivation :bulb:
## :bulb: Motivation

Currently there is no easy way to upgrade Kubernetes objects in case of Kubernetes newer versions. There are some tools
which are available for this purpose, but we found them inadequate for migration requirements.
Expand All @@ -52,7 +52,7 @@ Supported input formats
It provides details of issues with the Kubernetes object in case they are migrated to cluster with newer Kubernetes
version.

## Getting Started :rocket:
## :rocket: Getting Started

### Quick Installation

Expand Down Expand Up @@ -88,7 +88,7 @@ docker run -v /host/path-to/.kube-dir/:/opt/.kube --privileged --net=host --name

You can download the binaries for Windows, Linux and MacOS from the [release page](https://github.com/devtron-labs/silver-surfer/releases) on this repository.

## Usage :gear:
## :gear: Usage

Use the binary `./kubedd` to execute the commands and get insights of your current Kubernetes objects.

Expand Down Expand Up @@ -123,7 +123,7 @@ Flags:
--version version for kubedd
```

## Output :file_folder:
## :file_folder: Output

It categorises Kubernetes objects based on change in ApiVersion. Categories are -

Expand All @@ -140,7 +140,7 @@ Within each category it identifies migration path to newer ApiVersion, possible

This activity is performed for both current and new ApiVersion.

## Contribute :handshake:
## :handshake: Contribute

Collaborations and contributions are the beauty of open source communities. It creates an environment where we learn, inspire and create amazing tools with the help of community to solve the real-life use cases. Here are couple of ways you can contribute to silver-surfer -

Expand All @@ -150,7 +150,7 @@ Collaborations and contributions are the beauty of open source communities. It c

Check out our [contributing guidelines](CONTRIBUTING.md) for more details. We deeply appreciate your contributions.

## Other Similar Tools :link:
## :link: Other Similar Tools

1. [kubeval](https://github.com/instrumenta/kubeval) - The most popular, only validates against the given Kubernetes version, doesn't provide migration path and is no longer maintained.
2. [kube-no-trouble](https://github.com/doitintl/kube-no-trouble) - Provides information about removed and deprecated APIs but doesn't validate schema.
Expand Down

0 comments on commit 3e488b6

Please sign in to comment.