antidote-core

module
v0.7.0 Latest Latest
Warning

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

Go to latest
Published: Dec 14, 2020 License: Apache-2.0

README

Antidote-Core

Go Build Status codecov Go Report Card

This repository is where the core services of the Antidote project are maintained. This includes antidoted, which is the primary service for provisioning curriculum content within a Kubernetes infrastructure.

If you're looking for the web front-end for Antidote, that code is maintained in a separate repository: antidote-web.

The Antidote documentation contains additional architectural details.

Hacking

To build antidote-core, you'll need Go installed. Any modern version of Go should suffice, but the "officially" supported version is whatever is listed in the Dockerfile. Within the antidote-core repository, compile binaries with:

make

To run tests:

make test

If you want to run the core server (antidoted) - you'll need to provide a configuration file. Below is a minimal version with only the api service enabled (see the config package for all supported config options):

---
curriculumDir: /path/to/curriculum
instanceId: antidote-dev
enabledServices:
- api
# - stats
# - scheduler

You will also need to run a copy of NATS - this docker one-liner should do the trick:

docker run --rm -d -p 4222:4222 -p 6222:6222 -p 8222:8222 --name nats-main nats

Note that antictl and antidote are also compiled alongside antidoted. They do not have third-party runtime dependencies like antidoted does, but may depend on access to a running antidoted instance in order to be fully functional (especially antictl).

Directories

Path Synopsis
api
exp
cmd
db
pkg
apis/k8s.cni.cncf.io/v1
Package v1 is the v1 version of the API.
Package v1 is the v1 version of the API.
client/clientset/versioned
This package has the automatically generated clientset.
This package has the automatically generated clientset.
client/clientset/versioned/fake
This package has the automatically generated fake clientset.
This package has the automatically generated fake clientset.
client/clientset/versioned/scheme
This package contains the scheme of the automatically generated clientset.
This package contains the scheme of the automatically generated clientset.
client/clientset/versioned/typed/k8s.cni.cncf.io/v1
This package has the automatically generated typed clients.
This package has the automatically generated typed clients.
client/clientset/versioned/typed/k8s.cni.cncf.io/v1/fake
Package fake has the automatically generated clients.
Package fake has the automatically generated clients.

Jump to

Keyboard shortcuts

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