Skip to content

Latest commit

 

History

History
230 lines (174 loc) · 6.78 KB

README.md

File metadata and controls

230 lines (174 loc) · 6.78 KB
Raw

units-tests-status Repository license GitHub watchers GitHub stars GitHub forks

GitHub go.mod Go version Go Report Card

ACK Development tools

A list of tools and binaries that will make your contributor journey easier and much more enjoyable.

ackdev

This tool is still a work in progress. Expect dragons 🐉 and fires 🔥.

ackdev is a command line that helps ACK contributors to manage, test and generate controllers. It also helps you manage dependencies, local repositories and github forks.

Installation

By forking/cloning the repository

First fork the aws-controllers-k8s/dev-tools repo and rename it to $GH_USERNAME/ack-dev-tools then run the script below - after replacing "A-Hilaly" with your own GitHub username.

export GH_USERNAME="A-Hilaly"
cd $HOME/go/src/github.com/aws-controllers-k8s
git clone [email protected]:$GH_USERNAME/ack-dev-tools dev-tools
cd dev-tools
git remote add upstream [email protected]:aws-controllers-k8s/dev-tools
git fetch --all

# Make sure to a have a Go compiler >v1.9 installed locally
cd dev-tools && make install

Using go get (after merge)

go get github.com/aws-controllers-k8s/dev-tools/cmd/ackdev

Usage

Call ackdev help for detailed usage instructions.

Setup

To be able to use ackdev you'll have to run ackdev setup before any other command.

For example

ackdev setup --root-directory $WORKDIR --services s3,ecr,sqs,sns

The setup command will simply create a yaml file named $HOME/.ackdev.yaml (you can choose a different file path --config-file)

NOTE: If you are a contributor you probably want to leave --root-directory empty which will default to $GOPATH/src/github.com/aws-controllers-k8s (make sure that this directory exists). If you only want to test the tool, We recommended you to set your $WORKDIR to a different directory.

Will my projects work/compile if I use a different directory than $GOPATH/src/github.com/aws-controllers-k8s ?

Yes, even if it's not inside GOPATH, it will work as expected. Since Go 1.11.4 the Go compiler doesn't rely entirely on GOPATH to build projects.

The generated configuration file will look like:

rootDirectory: /home/amine/go/source/github.com/aws-controllers-k8s/dev-tools
git:
  sshKeyPath: ""
github:
  token: ""
  username: ""
  forkPrefix: ""
repositories:
  core:
  - runtime
  - dev-tools
  - community
  - code-generator
  services:
  - s3
  - ecr
  - sns
  - sqs
run:
  flags: {}

To use all ackdev features you will need to fill the git.sshKeyPath and github sections. You can do that using the ackdev edit config command,

The git.sshKeyPath should point to the private key you use to push commits to your forks on Github.

The github.token should contain a token that give fork/renaming permissions (repo/* policies). You can create one by following these instructions.

Examples

Manage ackdev configuration

You can view the configuration used by ackdev by calling:

ackdev get config

The output will look like:

rootDirectory: /home/amine/source/github.com/aws-controllers-k8s
git:
  sshKeyPath: /home/amine/.ssh/id_ed25519
github:
  token: somerandomtoken165489415631684131
  username: A-Hilaly
  forkPrefix: ack-
repositories:
  core:
  - runtime
  - community
  - code-generator
  - dev-tools
  - test-infra
  services:
  - s3
  - sns
  - dynamodb
  - ecr
  - elasticache
  - sagemaker
  - sqs
  - lambda
run:
  flags:
    aws-account-id: "000000000000"
    aws-region: eu-west-2
    enable-development-logging: "true"
    log-level: debug

To edit the configuration you can simply call:

ackdev edit config

by default this will open the configuration file using your OS default editor which is stored in the EDITOR environment variable. If this variable is not set ackdev will open the configuration using vi.

List dependencies

ackdev can help you manage dependencies and tools you will need in your ACK development journey. To start you can run:

ackdev list deps # dep|dependency|dependencies [--short-path]

The output will look like:

NAME           STATUS    VERSION         PATH                     
go             OK        1.15.6          /usr/local/go/bin/go     
kind           OK        0.9.0           /usr/local/bin/kind      
helm           OK        v3.2.4+g0ad800e /usr/local/bin/helm      
mockery        NOT FOUND -                                        
kubectl        OK        v1.20.0         /usr/local/bin/kubectl   
kustomize      OK        v4.0.1          /usr/local/bin/kustomize 
controller-gen OK        v0.4.0          /usr/bin/controller-gen

Managed repositories

ackdev can help manage the repositories you need to interact with in your ACK development journey. To list all the repositories that you have configured, you can run:

ackdev list repos # repo|repository|repositories [--filter|--show-branch]

The output will look like this:

NAME                   TYPE       BRANCH 
test-infra             core       main   
runtime                core       main   
code-generator         core       main   
dev-tools              core       main   
dynamodb-controller    controller main   
ecr-controller         controller main   
s3-controller          controller main   
eks-controller         controller main   
sqs-controller         controller main   
s3-controller          controller main   
mq-controller          controller main   
elasticache-controller controller main

You can filter repositories by name, type, branch or name prefix. e.g --filter=type=controller

To configure and ensure (fork+clone) a new repository you can run:

ackdev add repo eks --type=controller

To ensure that all the configured repositories are forked in your github account and cloned in your local GOPATH, you can run:

ackdev ensure repos

License

This project is licensed under the Apache-2.0 License.

Security

See CONTRIBUTING for more information.