🪙 Charlie

Docker image for executing python code directly from gitlab/github repository. You can use this image to execute python scripts on okd or any other cloud platform without needing any pipeline, dockerfile or anything. All you have to do is build charlie and then set some env variable. Then login with your snapp-cloud account into the namespace that you want. Create an image registry, build and push this image into it and use it.

In snappline we use charlie in order to execute python scripts as crob jobs in okd4.

🔓 Login

docker login -u <okd4-user> -p <okd4-token> <registery>/<namespace>

✔️ Requirements

Make sure to have these files:

• script.py file which contains the main function of the script.
• libs/requirements.txt python project requirements when building the image (this will setup your image with requirements that you need). In this file you have to write your external python libraries. Docker image will be built from this file.

🔨 Build

First build your image:

docker buildx build --platform linux/amd64 . -t <snapp-image-registery>/<namespace>/charlie:v0.1.0 -f build/Dockerfile

📌 Push

Push image to your namespace image stream:

docker push <snapp-image-registery>/<namespace>/charlie:v0.1.0

🔧 Environment Variables

• REPOSITORY git repository url. Example: gitlab.snapp.ir/snappline/api
• DIRECTORY name of the directory when it's done cloning. Example: api
• SCRIPT_PATH directory of script. Example: script/report
• HTTP_SECURE using http or https. Expect: true/false
• GIT_SECURE if your repository is private set true
• GIT_USER repository user for secure option
• GIT_TOKEN user token for secure option

💣 Run

🐳 Docker

Use the built image in order to execute your code:

docker run \
--env REPOSITORY='github.com/amirhnajafiz/charlie' \
--env DIRECTORY='charlie' \
--env SCRIPT_PATH='test' \
--mount type=bind,source="$(pwd)/clone",target=/src/clone \
<snapp-image-registery>/charlie@v0.1.0

🚢 Kubernetes Job

Example job that executes once in a day to do something.

Configmap

apiVersion: v1
kind: ConfigMap
metadata:
  name: report-configs
data:
  REPOSITORY: 'gitlab_repository'
  DIRECTORY: 'export'
  SCRIPT_PATH: 'script'
  HTTP_SECURE: 'true'
  GIT_SECURE: 'true'
  GIT_USER: 'amirhossein.najafizadeh'
  GIT_TOKEN: 'can be read from secret'

Job

apiVersion: batch/v1
kind: CronJob
metadata:
  name: report-job
  labels:
    app.snappcloud.io/created-by: snappline
    app: report
spec:
  schedule: "* * */1 * *"
  jobTemplate:
    spec:
      template:
        spec:
          containers:
            - name: charlie
              image: <registery>/<namespace>/charlie:v0.3.0
              volumeMounts:
                - mountPath: /src/clone
                  name: report-dir
              envFrom:
                - configMapRef:
                    name: report-configs
          restartPolicy: Never
          volumes:
            - name: report-dir
              emptyDir: { }