charmcraft.yaml

# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

name: opencti
title: OpenCTI Charm
summary: OpenCTI charm.
links:
  documentation: https://github.com/canonical/opencti-operator/blob/main/README.md
  issues: https://github.com/canonical/opencti-operator/issues
  source: https://github.com/canonical/opencti-operator
  contact: https://launchpad.net/~canonical-is-devops

description: |
  A [Juju](https://juju.is/) [charm](https://juju.is/docs/olm/charmed-operators) 
  for deploying and managing the [OpenCTI](https://filigran.io/solutions/open-cti/)
  open-source threat intelligence platform in your systems.
  
  This charm simplifies the configuration and maintenance of OpenCTI across a 
  range of environments, organize your cyber threat intelligence to enhance 
  and disseminate actionable insights.

config:
  options:
    admin-user:
      type: string
      description: |
        OpenCTI admin user email and password.  
        The content of this configuration should be a Juju user secret ID.  
        The Juju user secret should contain two fields, `email` and `password`, 
        where `email` is the admin user email, and `password` is the admin user password.  
        Use the following commands to create a Juju user secret for this configuration:  
        `juju add-secret opencti-admin-user email=admin@example.com password#file=/path/to/password.txt`  
        `juju grant-secret opencti-admin-user opencti`

requires:
  opensearch-client:
    interface: opensearch_client
    optional: false
    limit: 1
  redis:
    interface: redis
    optional: false
    limit: 1
  amqp:
    interface: rabbitmq
    optional: false
    limit: 1
  s3:
    interface: s3
    optional: false
    limit: 1
  ingress:
    interface: ingress
    optional: false
    limit: 1
  logging:
    interface: loki_push_api
    optional: true

provides:
  metrics-endpoint:
    interface: prometheus_scrape
    optional: true
  grafana-dashboard:
    interface: grafana_dashboard
    optional: true

peers:
  opencti-peer:
    interface: opencti_peer

type: charm
base: ubuntu@24.04
build-base: ubuntu@24.04
platforms:
  amd64:
parts:
  charm:
    build-snaps:
      - rustup
    override-build: |
      rustup default stable
      craftctl default
    build-packages:
      - libffi-dev
      - libssl-dev
      - pkg-config

containers:
  opencti:
    resource: opencti-image
resources:
  opencti-image:
    type: oci-image
    description: OCI image for the OpenCTI platform/worker.

assumes:
  - juju >= 3.4