pygeoapi-config.yaml

server:
  bind:
    host: 0.0.0.0
    port: 80
  url: http://localhost:80
  mimetype: application/json; charset=UTF-8
  encoding: utf-8
  gzip: false
  languages:
    # First language is the default language
    - en-US
    - fr-CA
  # cors: true
  pretty_print: true
  limits:
    default_items: 50
    max_items: 1000
    max_distance_x: 25
    max_distance_y: 25
    max_distance_units: m
    on_exceed: throttle
  map:
    url: https://tile.openstreetmap.org/{z}/{x}/{y}.png
    attribution: '&copy; <a href="https://openstreetmap.org/copyright">OpenStreetMap contributors</a>'
  manager:
    name: pygeoapi_k8s_manager.KubernetesManager
    logging:
      botocore: INFO
      kubernetes: INFO
      pygeoapi.l10n: ERROR
    # enable k8s finalizer controller
    finalizer_controller: true
  admin: false # enable admin api

logging:
  level: DEBUG
  #logfile: /tmp/pygeoapi.log
  #
  # default: '[%(asctime)s] {%(pathname)s:%(lineno)d} %(levelname)s - %(message)s'
  #
  # https://github.com/geopython/pygeoapi/blob/master/pygeoapi/log.py#L49-L51
  #
  # https://docs.python.org/3/library/logging.html#logrecord-attributes
  #
  logformat: '[%(asctime)s | %(name)s::%(module)s.py:%(lineno)d | %(process)d] %(levelname)s - %(message)s'
  #
  # default: '%Y-%m-%dT%H:%M:%SZ'
  #
  # https://github.com/geopython/pygeoapi/blob/master/pygeoapi/log.py#L52
  #
  # https://docs.python.org/3/library/time.html#time.strftime
  #
  dateformat: '%Y-%m-%dT%H:%M:%SZ'

metadata:
  identification:
    title:
      en: pygeoapi default instance
      fr: instance par défaut de pygeoapi
    description:
      en: pygeoapi provides an API to geospatial data
      fr: pygeoapi fournit une API aux données géospatiales
    keywords:
      en:
        - geospatial
        - data
        - api
      fr:
        - géospatiale
        - données
        - api
    keywords_type: theme
    terms_of_service: https://creativecommons.org/licenses/by/4.0/
    url: https://example.org
  license:
    name: CC-BY 4.0 license
    url: https://creativecommons.org/licenses/by/4.0/
  provider:
    name: Organization Name
    url: https://pygeoapi.io
  contact:
    name: Lastname, Firstname
    position: Position Title
    address: Mailing Address
    city: City
    stateorprovince: Administrative Area
    postalcode: Zip or Postal Code
    country: Country
    phone: +xx-xxx-xxx-xxxx
    fax: +xx-xxx-xxx-xxxx
    email: you@example.org
    url: Contact URL
    hours: Mo-Fr 08:00-17:00
    instructions: During hours of service. Off on weekends.
    role: pointOfContact

resources:
  hello-world-k8s:
    type: process
    processor:
      name: pygeoapi_k8s_manager.process.HelloWorldK8sProcessor
  hello-world-k8s-sleep:
    type: process
    processor:
      name: pygeoapi_k8s_manager.process.HelloWorldK8sProcessor
      command:
        - date
        - echo start and now sleeping 10s
        - sleep 10
  hello-world-k8s-sleep-failing:
    type: process
    processor:
      name: pygeoapi_k8s_manager.process.HelloWorldK8sProcessor
      command:
        - date
        - echo start and now sleeping 10s
        - sleep 10
        - echo oh no, we are failing
        - exit 1
  generic-image-processor-example:
    type: process
    processor:
      name: pygeoapi_k8s_manager.process.GenericImageProcessor
      metadata:
        version: 0.1
        id: generic-image-processor-example
        title:
          en: "Generic Image Processor Example"
        description:
          en: "Example Configuration of Generic Image Processor"
        keywords:
          - generic image processor example
          - example
          - generic image processor
          - k8s
          - k8s manager
          - KubernetesManager
        links:
          - type: text/html
            rel: about
            title: Processor Code Repository
            href: https://github.com/52North/pygeoapi_k8s-manager/tree/main/src/pygeoapi_k8s_manager/process/generic_image.py
            hreflang: en-UK
        inputs:
          token:
            title: secret token
            description: identify yourself
            schema:
              type: string
        outputs:
          logs:
            title: logs
            description: The logs of the job
            schema:
              type: string
              contentMediaType: application/json
        example:
          inputs:
            token: token
      default_image: bash:latest
      # OPTIONAL
      # image_pull_secrets: default-secret
      command:
        - bash
        - -c
        - "date; env | sort"
      env:
        # env from secrets (requires existing secrets in k8s cluster!)
        # - name: EXAMPLE_ENV_FROM_SECRET
        #   secret_name: example-secret-name
        #   secret_key: example-secret-key
        # simple env
        - name: SIMPLE_ENV_BOOLEAN_AS_STRING
          value: "False"
        - name: SIMPLE_ENV_BOOLEAN_AS_BOOLEAN
          value: False
        - name: SIMPLE_ENV_STRING
          value: "simple-env-string"
        - name: SIMPLE_ENV_INTEGER
          value: 1024
      resources:
        requests:
          memory: 16M
          cpu: 10m
        limits:
          memory: 256M
          cpu: 100m
      storage:
      # See: https://kubernetes.io/docs/concepts/storage/persistent-volumes/#persistentvolumeclaims
      - name: test-storage
        mount_path: /tmp/test-storage
        persistent_volume_claim_name: test-storage-pvc-name
      # See https://kubernetes.io/docs/concepts/storage/volumes/#emptydir
      - name: test-empty-dir-storage
        mount_path: /tmp/test-empty-dir-storage
        empty_dir: {}
      - name: test-empty-dir-storage-with-config
        mount_path: /tmp/test-empty-dir-storage-with-config
        empty_dir:
          size_limit: 500Mi
          medium: Memory
      tolerations:
      - key: "toleration-key"
        value: "toleration-value"
        operator: "Equal"
        effect: "NoSchedule"