Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
70 lines (48 loc) · 1.81 KB

DEVELOPMENT.md

File metadata and controls

70 lines (48 loc) · 1.81 KB

Development

Requirements

The following tools are required to start developing on the Sentry operator:

  • go v1.13+
  • kind v0.8.1+
  • docker v17.03+
  • kubectl v1.11.3+
  • kustomize v3.1.0+
  • kubebuilder v2.3.1+

You can install Kubebuilder and Kustomize by running:

./scripts/install.sh

You should also have a Sentry organization to test your changes against. It is recommended to create a sandbox account for this.

For the operator to communicate with the Sentry API, you will need to provide an authentication token from a user under your organization, with the following scopes:

  • org:admin, org:write, org:read
  • team:admin, team:write, team:read
  • project:admin, project:write, project:read

Getting Started

  1. Start a local Kubernetes cluster using kind:

    make cluster

  2. Install the CRDs into your cluster:

    make install

  3. Create a .env file in the repository's root containing the following environment variables:

    SENTRY_ORGANIZATION=<organization> # The slug of your Sentry organization
SENTRY_TOKEN=<token> # Your Sentry authentication token

  4. Run the operator locally:

    make run

  5. Write your code and verify the expected behaviour against your Sentry organization. Also include any appropriate tests.

  6. Run all test suites:

    make test

Resources