https://github.com/konveyor/move2kube-api

HTTP REST API for move2kube
https://github.com/konveyor/move2kube-api

hacktoberfest kubernetes modernization move2kube replatform

Last synced: about 2 months ago
JSON representation

HTTP REST API for move2kube

• Host: GitHub
• URL: https://github.com/konveyor/move2kube-api
• Owner: konveyor
• License: apache-2.0
• Created: 2020-09-23T14:01:48.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-08-26T07:19:17.000Z (almost 2 years ago)
• Last Synced: 2024-08-27T07:02:14.300Z (almost 2 years ago)
• Topics: hacktoberfest, kubernetes, modernization, move2kube, replatform
• Language: Go
• Homepage: https://move2kube.konveyor.io/
• Size: 1.08 MB
• Stars: 6
• Watchers: 13
• Forks: 18
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: contributing.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

          
[![Build](https://github.com/konveyor/move2kube-api/workflows/Build/badge.svg "Github Actions")](https://github.com/konveyor/move2kube-api/actions?query=workflow%3ABuild)

[![Docker Repository on Quay](https://quay.io/repository/konveyor/move2kube-api/status "Docker Repository on Quay")](https://quay.io/repository/konveyor/move2kube-api)

[![License](https://img.shields.io/:license-apache-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/konveyor/move2kube-api/pulls)

[![Go Report Card](https://goreportcard.com/badge/github.com/konveyor/move2kube-api)](https://goreportcard.com/report/github.com/konveyor/move2kube-api)

[](https://kubernetes.slack.com/archives/CR85S82A2)

# Move2Kube-API

Move2Kube API provides a REST interface to interact with move2kube [command line tool](https://github.com/konveyor/move2kube).

The API is documented here: https://github.com/konveyor/move2kube-api/blob/main/assets/openapi.json  

(Use https://editor.swagger.io/ to view it.)

![API inputs](./assets/images/api-1.png)

![API outputs](./assets/images/api-2.png)

## Usage

Run using container from registry using `make crun`

## Setup

1. Obtain a recent version of `golang`. Known to work with `1.19`.

1. Ensure `$GOPATH` is set. If it's not set:

   1. `mkdir ~/go`

   1. `export GOPATH=~/go`

1. Obtain this repo:

   1. `mkdir -p $GOPATH/src/`

   1. Clone this repo into the above directory.

   1. `cd $GOPATH/src/move2kube-api`

1. Build: `make build`

1. Run unit tests: `make test`

1. Run image build: `make cbuild`

1. Run image: `make crun`

## Discussion

* For any questions reach out to us on any of the communication channels given on our website https://move2kube.konveyor.io/