Welcome! This page is a series of short tutorials to get Kebechet running on your repositories. The tutorials are in ascending complexity so we recommend starting with installing the GitHub app and then moving up from there based on your own personal use case.
To configure Kebechet, your repository should have a
.thoth.yamlfile in the root directory of the repository. Below you can find an example configuration file that has been annotated
host: khemenu.thoth-station.ninja # url of Thoth's user-api requirements_format: pipenv # tool used for managing python package dependencies overlays_dir: overlays # if your repository contains more than one runtime environment runtime_environments: - name: rhel-8 # this will be used to find the environment specific files <overlay-dir>/<name> operating_system: name: rhel version: "8" python_version: "3.8" recommendation_type: latest # if thoth-advise is being used this indicates priority for dependencies managers: - name: foo configuration: # manager specific configuration labels: [bot]
Go to this link https://github.com/marketplace/khebhut
Choose the repositories and orgs that you want to install Kebechet on
Congratulations! You have now installed Kebechet and it will actively manage your repositories. Kebechet’s behaviour is highly dependent on which managers you have installed we recommend familiarizing yourself with the managers you installed. This service is provided by the Thoth team at Red Hat.
- Info Manager
- Label Bot
- Pipfile Requirements Manager
- Thoth Advise Manager
- Thoth Provenance Manager
- Update Manager
- Version Manager
Running Kebechet might interest you if you are a developer, someone looking to deploy Kebechet on their own, or if you are just curious.
See step 1 of GitHub Application
- Setting up tokens and keys
- Setting Environment Variables
To interface with GitHub, GitLab, and Pagure you must set:
PAGURE_KEBECHET_TOKENrespectively. These are the “Personal Access Tokens” that you generated in the previous step.
Beyond these there is no requirement for environment variables, however the CLI can be used by only setting environment variables. To see all of these values use the
--helpoption when running the CLI.
- Running Kebechet
$ pipenv run PYTHON_PATH=. kebechet-cli run-url -u <url-to-github-repo> -s <GITHUB|GITLAB|PAGURE>
To get more information about the available commands run:
$ pipenv run PYTHON_PATH=. kebechet-cli --help
And to get more information about a specific command, including cli-options, run:
$ pipenv run PYTHON_PATH=. kebechet-cli <command> --help
We release Kebechet images on quay.io. The entry point for
the container is
app.sh in the root directory of the Git repository.
Project Thoth uses Argo Workflows for our deployment of Kebechet. Here is a link to a basic workflow template to run Kebechet.
If you want to deploy Kebechet using different tooling please reachout if you need help or extend the documentation so others can benefit from your experience.