APL Tasks

Part of APL - Application Platform for LKE (Linode Kubernetes Engine).

The tasks repo contains autonomous jobs orchestrated by redkubes/otomi-core.

This repo is also built as an image and published on docker hub at otomi/tasks.

This readme is aimed at development. If you wish to contribute please read our Developers Contributor Code of Conduct and Contribution Guidelines

Development

Make sure your expected environment variables exist in a mandatory .env file (see .env.sample).

Important When using npm i and you get the errors Unauthorized and Permission denied on the installation regarding getting packages from redkubes

Example: npm ERR! 403 403 Forbidden - GET https://npm.pkg.github.com/linode/@linode%2fgitea-client-node - Permission denied

This can be fixed by adding the following line to the .npmrc file. //npm.pkg.github.com/:_authToken=PERSONAL_ACCESS_TOKEN_HERE

To create a personal access token, go to GitHub -> settings -> developer settings -> personal access token -> give read permission on packages and create the token

Remember not to push this token

Then start a proxy to the api you wish to target:

• gitea: k -n gitea port-forward svc/gitea-http 8082:3000 &
• harbor: k -n harbor port-forward svc/harbor-core 8083:80 &
• keycloak: k -n keycloak port-forward svc/keycloak-operator 8084:80 &

Or start them all with bin/start-proxies.sh

Now you can execute a task locally:

npm run tasks:(gitea*|harbor|keycloak|certs-aws|...)-dev

Or start them in vscode from the debug menu. (Don't forget to add a profile for any new tasks!)

Testing https with self-signed certs

When targeting https://... services with self-signed certs, also create a .env.ca file (just copy .env.ca.letsencrypt-staging to .env.ca when using issuer: letsencrypt-staging), and export it before running tasks:

export NODE_EXTRA_CA_CERTS='./.env.ca'

Or just skip ssl verification altogether with:

export NODE_TLS_REJECT_UNAUTHORIZED='0'

Setting debug level:

For all npm packages (that support it) to turn on debug, edit .env and uncomment DEBUG='*'

To limit scope please read the debug docs.

Unit tests

There are not many unit tests, as the tasks are very robust and idempotent. You can run them as always with:

npm test