Skip to content

Latest commit

 

History

History
33 lines (26 loc) · 1.34 KB

CONTRIBUTING.md

File metadata and controls

33 lines (26 loc) · 1.34 KB
Raw

Contributing

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Please don't file an issue to ask a question. You'll get faster results by reaching out to the community on our discord channel.

The following is a set of guidelines for contributing to this repository.

Setting up development environment

  • Install ct (Official CLI tool for linting and testing helm charts)
  • Install helm-docs for auto doc generation
  • Kind (optional for local testing)

Usage

# Setup cluster
kind create cluster
# Install chart (default is to use the AWS plugin)
helm install cloudquery ./charts/cloudquery/ -f ./charts/cloudquery/values.yaml \
    # These environment variables should be exported before running the command
    --set envRenderSecret.CQ_DSN=$CQ_DSN \
    --set envRenderSecret.AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID \
    --set envRenderSecret.AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY \
    --set envRenderSecret.AWS_SESSION_TOKEN=$AWS_SESSION_TOKEN
# Trigger cron job
kubectl create job --from=cronjob/cloudquery-cron cloudquery-cron -n default
# Get cron job logs
kubectl logs -f jobs/cloudquery-cron -n default
# Cleanup cluster
kind delete cluster