charter/docs/examples/example-plugin.yaml at main · rh-ai-community-plugins/charter · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# Example plugin.yaml — copy this as a starting point for your plugin.
# See docs/plugin-spec.md for the full specification.
# Fields marked [PLUGIN-SPECIFIC] must be customized for your plugin.

# --- Required fields ---

name: my-plugin                    # [PLUGIN-SPECIFIC] unique plugin identifier (kebab-case)
displayName: My Plugin             # [PLUGIN-SPECIFIC] human-readable name
description: A one-line description of what this plugin does
version: 0.1.0

maintainer:                        # [PLUGIN-SPECIFIC]
  name: Your Name
  github: your-github-handle

rhoai_compatibility:               # [PLUGIN-SPECIFIC]
  min_version: "3.4.0"
  tested_versions: ["3.4.0"]

# per-project: user provisions instances per namespace
# cluster-shared: admin installs once, all authorized users share
# both: plugin supports either mode (Helm values switch between them)
deployment_model: per-project

image:                             # [PLUGIN-SPECIFIC]
  repository: quay.io/rh-ai-community-plugins/my-plugin
  tag: "0.1.0"

install:
  method: automatic                # automatic | assisted | manual
  helm:
    chart_path: chart/
    registry: oci://quay.io/rh-ai-community-plugins/my-plugin  # [PLUGIN-SPECIFIC]
  prerequisites: []
  instructions: https://github.com/your-org/my-plugin/docs/INSTALL.md  # [PLUGIN-SPECIFIC]

remote:
  type: module-federation
  spec:
    name: myPlugin                 # [PLUGIN-SPECIFIC] Module Federation container name (camelCase)
    scope: myPlugin                # [PLUGIN-SPECIFIC] must match name above
    # [PLUGIN-SPECIFIC] Update this URL to point to your deployed OpenShift route.
    remoteEntry: https://<your-openshift-route>/remoteEntry.js
    paths:
      - type: route
        path: /my-plugin           # [PLUGIN-SPECIFIC] must match route prefix in extensions.ts
        extensions:
          - myPlugin/extensions    # [PLUGIN-SPECIFIC] {scope}/extensions
      - type: icon
        path: myPlugin/Icon        # [PLUGIN-SPECIFIC] {scope}/Icon

rbac:
  required_roles: []
  # Set to true only if absolutely necessary — requires justification in PR
  cluster_roles: false

# --- Optional fields ---

# bff_image:                       # Only if using Backend-For-Frontend pattern
#   repository: quay.io/rh-ai-community-plugins/my-plugin-bff  # [PLUGIN-SPECIFIC]
#   tag: "0.1.0"

dependencies:
  - name: postgresql
    version: ">=14"
    required: true

resources:
  requests:
    cpu: 100m
    memory: 256Mi
  limits:
    cpu: 500m
    memory: 512Mi

telemetry:
  opt_in: true
  metrics_endpoint: /metrics

support:
  repo: https://github.com/your-org/your-plugin     # [PLUGIN-SPECIFIC]
  docs: https://github.com/your-org/your-plugin/docs
  issues: https://github.com/your-org/your-plugin/issues

screenshots:
  - path: docs/screenshots/overview.png
    caption: Plugin overview page
  - path: docs/screenshots/settings.png
    caption: Configuration panel