Skip to content

Latest commit

 

History

History
54 lines (39 loc) · 2.3 KB

README.md

File metadata and controls

54 lines (39 loc) · 2.3 KB
Raw

Local development environment

We provide a script and some templates to setup a local test environment based on kind. The templates can be found in directory templates/.

Prerequisites

  • bash
  • sed
  • kind
  • kubectl
  • kubelogin as kubectl-oidc_login
  • OpenSSL (LibreSSL might not be able to generate the necessary setup for the local dev environment)

The setup script will provide links to the install guides for kubectl and kubelogin if no appropriate command is found.

Installation

The setup-kind.sh script will guide you through the setup. There are some steps that you have to perform manually on a Keycloak instance, which the script prompts you for. The script defaults to VSHN's APPUiO Dev Keycloak instance, but you can provide an URL pointing to a different instance during the install process.

Since the setup script requires a few arguments, we provide a make target to run the script:

make setup

Billing Entities

The control-api serves BillingEntities normally from Odoo directly as an aggregated API. For local development, this is hard to set up, so the API server has an in-memory fake store if Odoo isn't connected.

Thus, to create some fake entries, you can manually create them as normal resources. There's an example in config/examples/billing-entity.yaml.

Note that the data is lost when the control-api Pod is shut down. When this case happens, delete the be-####-viewer cluster role and -binding before recreating the objects.

Invitations

As described in Invitation API, you can redeem invitations.

If you are developing for Portal and have a local dev instance running on localhost:4200, you can generate invitation links. To get the invitation Links, run Kubectl with a template, like this:

kubectl get invitations -o go-template-file=local-env/templates/invitation-token.tpl

This returns URLs like following:

http://localhost:4200/invitations/44fb8124-199d-4cb6-b417-02aee1435b8d?token=35743705-a742-442d-b6ff-dcd9f67d9c4c
http://localhost:4200/invitations/5184d9db-1e7a-4385-8405-911665ad6154?token=e063cfd3-a232-498f-9db8-54884f65e12d

Note: Already redeemed invitations are not listed.