ACS Fleet Manager

ACS fleet-manager repository for the ACS managed service.

Quickstart

Overview

├── bin                 -- binary output directory  
├── cmd                 -- cmd entry points
├── config              -- various fleet-manager configurations
├── dashboards          -- grafana dashboards
├── docs                -- documentation
├── docker              -- docker images
├── dp-terraform        -- terraforming scripts for data-plane clusters
├── e2e                 -- e2e tests
├── fleetshard          -- source code for fleetshard-synchronizer
├── internal            -- internal source code
├── openapi             -- openapi specification
├── pkg                 -- pkg code
├── scripts             -- development and test scripts
├── secrets             -- secrets which are mounted to the fleet-manager
├── templates           -- fleet-manager openshift deployment templates
└── test                -- test mock servers

Getting started

Prerequisites

Golang 1.17+
Docker - to create database
ocm cli - ocm command line tool
Node.js v12.20+ and npm

A running kubernetes cluster
Setting up configurations described here

Getting started

To run fleet-manager in different ways (i.e. with docker) please refer to running-fleet-manager.md.

# Export the kubeconfig path the central instance should be deployed to
$ export KUBECONFIG=/your/kubeconfig

# Sets up database, starts fleet-manager
$ make setup-dev-env

# Start fleetshard-sync
$ OCM_TOKEN=$(ocm token --refresh) CLUSTER_ID=1234567890abcdef1234567890abcdef ./fleetshard-sync

# To create a central instance
$ ./scripts/create-central.sh

# To interact with the API use
$ ./scripts/fmcurl

Prepare a cluster for the local environment

You can run ACS Fleet Manager on a local k8s cluster (colima, rancher, minikube). This requires some preparations on a cluster:

Install ACS Operator The process is described in operator documentation
Deploy OpenShift Router
```
make deploy/openshift-router
```
Use make undeploy/openshift-router to undeploy the OpenShift router from a cluster. Refer to the router repo for more information.
For accessing the hostnames exposed by routes locally read the documentation here

Common make targets

# Install git-hooks, for more information see git-hooks.md [1]
$ make setup/git/hooks

# To generate code and compile binaries run
$ make all

# To only compile fleet-manager and fleetshard-synchronizer run
$ make binary

# Run API docs server
$ make run/docs

# Generate code such as openapi
$ make generate

# Testing related targets
$ make test
$ make test/e2e
$ make test/integration

# Fleet-manager database related make targets
$ make db/teardown
$ make db/setup
$ make db/migrate

[1] git-hooks.md

Background

This project was started from a fleet-manager template with an example "Dinosaur" application as a managed service. Implementations which reference "Dinosaur" are replaced iteratively.

For a real service written using the same fleet management pattern see the kas-fleet-manager. Original fleet-manager template.

To contact the people that created this template go to zulip.

Additional documentation

Contributing

See the contributing guide for general guidelines on how to contribute back to the template.

ekmixon / acs-fleet-manager Goto Github PK