Skip to content

Latest commit

 

History

History
80 lines (53 loc) · 3.1 KB

README.md

File metadata and controls

80 lines (53 loc) · 3.1 KB
Raw

Contribution Guide

SentryFlow operates within Istio on Kubernetes. This means project participants will need an Istio environment.

To minimize the hassle of installing (uninstalling) Kubernetes and configuring Istio, we have prepared a Vagrantfile that initializes an Ubuntu VM with fully functional Kubernetes and Istio.

1. Prerequisites

The provided Vagrantfile is tested on the following environment (i.e., Vagrant with VirtualBox).

2. Starting up a VM

To proceed, execute the following command within the contribution/ directory:

$ vagrant up
Bringing machine 'sentryflow' up with 'virtualbox' provider...
==> sentryflow: Importing base box 'generic/ubuntu2204'...
==> sentryflow: Matching MAC address for NAT networking...
==> sentryflow: Checking if box 'generic/ubuntu2204' version '4.3.10' is up to date...
...
    sentryflow: clusterrolebinding.rbac.authorization.k8s.io/calico-node created
    sentryflow: clusterrolebinding.rbac.authorization.k8s.io/calico-cni-plugin created
    sentryflow: daemonset.apps/calico-node created
    sentryflow: deployment.apps/calico-kube-controllers created

This command will initiate the installation of the necessary development environment. The duration of this process may vary, primarily depending on the speed of your network connection, and could take several minutes to complete.

3. Development and Code Quality

Development

Once Vagrant has been initialized successfully, you can access the Kubernetes environment by following these steps:

$ vagrant ssh

The source code for SentryFlow will be located at /home/vagrant/sentryflow within the virtual environment, and this directory will also be synchronized with the current working directory on the host machine.

After making modifications to the source code of SentryFlow, you can build the changes by navigating to the sentryflow directory and running the Makefile.

make build

Executing the Makefile will result in the construction of container images, each tagged as specified.

Code Quality

To maintain a clean and secure code base for SentryFlow, we conduct several checks, including gofmt for code formatting, golint for code style and linting, and gosec for security scanning.

To evaluate the quality of your code, navigate to the sentryflow directory and execute the following commands:

make golint # run golint checks
make gofmt  # run gofmt checks
make gosec  # run gosec checks

Pull Request

Once everything is correctly set up, you are ready to create a pull request. Please refer to our guidelines for submitting PRs.

4. Cleaning Up

If you have successfully made changes to SentryFlow and wish to clean up the created workspace, you can simply use the following command:

$ vagrant destroy
    sentryflow: Are you sure you want to destroy the 'sentryflow' VM? [y/N] y
==> sentryflow: Forcing shutdown of VM...
==> sentryflow: Destroying VM and associated drives...

Executing the command will terminate and remove the VM that you were working on.