Merge pull request #54 from mbaldessari/metadata

metadata

Author: mbaldessari

.github/workflows/update-metadata.yml

@@ -0,0 +1,23 @@
+# This job requires a secret called DOCS_TOKEN which should be a PAT token
+# that has the permissions described in:
+# validatedpatterns/docs/.github/workflows/metadata-docs.yml@main
+---
+name: Update docs pattern metadata
+
+on:
+  push:
+    paths:
+      - "pattern-metadata.yaml"
+      - ".github/workflows/update-metadata.yml"
+
+jobs:
+  update-metadata:
+    uses: validatedpatterns/docs/.github/workflows/metadata-docs.yml@main
+    permissions: # Workflow-level permissions
+      contents: read  # Required for "read-all"
+      packages: write # Allows writing to packages
+      id-token: write # Allows creating OpenID Connect (OIDC) tokens
+    secrets: inherit
+    # For testing you can point to a different branch in the docs repository
+    # with:
+    #  DOCS_BRANCH: "main"

pattern-metadata.yaml

@@ -0,0 +1,40 @@
+# This goal of this metadata is mainly used as a source of truth for
+# documentation and qe
+metadata_version: "1.0"
+name: rag-llm-gitops
+pattern_version: "1.0"
+display_name: RAG LLM Gitops
+repo_url: https://github.com/validatedpatterns/rag-llm-gitops
+docs_repo_url: https://github.com/validatedpatterns/docs
+issues_url: https://github.com/validatedpatterns/rag-llm-gitops/issues
+docs_url: https://validatedpatterns.io/patterns/rag-llm-gitops/
+ci_url: https://validatedpatterns.io/ci/?pattern=ragllm
+# can be sandbox, tested or maintained
+tier: tested
+owners: day0hero, sauagarwa
+requirements:
+  hub: # Main cluster
+    compute:
+      platform:
+        aws:
+          replicas: 3
+          type: m5.2xlarge
+    controlPlane:
+      platform:
+        aws:
+          replicas: 1
+          type: m5.2xlarge
+
+# Loosely defined extra features like hypershift support, non-openshift
+# kubernetes support, spoke support
+extra_features:
+  hypershift_support: false
+  spoke_support: false
+
+external_requirements:
+  # This gets added as a note in the cluster sizing doc page
+  cluster_sizing_note: >
+    This pattern will require nodes with GPUs which are only supported in certain regions.
+    You can create them before deploying the pattern via the special `make
+    create-gpu-machineset` command, after the initial cluster has been created.
+# external quay, s3 bucket, agof tokens to access paywalled material, manifests, rag-llm hw (only selected regions)