mgmt-backend

module
v0.3.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 21, 2023 License: Apache-2.0

README

mgmt-backend

mgmt-backend communicates with Versatile Data Pipeline (VDP) to manage the user resources.

Local dev

On the local machine, clone vdp repository in your workspace, move to the repository folder, and launch all dependent microservices:

$ cd <your-workspace>
$ git clone https://github.com/instill-ai/vdp.git
$ cd vdp
$ make dev PROFILE=mgmt ITMODE=true

Clone mgmt-backend repository in your workspace and move to the repository folder:

$ cd <your-workspace>
$ git clone https://github.com/instill-ai/mgmt-backend.git
$ cd mgmt-backend
Build the dev image
$ make build
Run the dev container
$ make dev

Now, you have the Go project set up in the container, in which you can compile and run the binaries together with the integration test in each container shell.

Run the server in the container

Enter the container

$ docker exec -it mgmt-backend-cloud /bin/bash

Create the database

$ go run ./cmd/migration

Initialise the database

$ go run ./cmd/init

Build binaries

$ go build -o /mgmt-backend/exec/mgmt-backend ./cmd/main
$ go build -o /mgmt-backend/exec/plugin ./cmd/plugin

Run the server

$ /mgmt-backend/exec/mgmt-backend
Run the integration test
$ docker exec -it mgmt-backend /bin/bash
$ make integration-test
Stop the dev container
$ make stop
CI/CD

The latest images will be published to Docker Hub repository at release.

License

See the LICENSE file for licensing information.

Directories

Path Synopsis
cmd
internal
pkg
db

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL