Skip to content

Commit 562818b

Browse files
committed
doc: update readme.md for what needs to be updated
1 parent 1e323f1 commit 562818b

4 files changed

Lines changed: 49 additions & 116 deletions

File tree

argocd-app.yaml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ spec:
1010
namespace: trieve
1111
source:
1212
repoURL: https://devflowinc.github.io/trieve-helm
13-
targetRevision: 0.2.32
13+
targetRevision: 0.2.33
1414
chart: trieve
1515
helm:
1616
releaseName: trieve-local
@@ -187,7 +187,7 @@ spec:
187187
enabled: false
188188
metrics:
189189
serviceMonitor:
190-
enabled: false
190+
enabled: true
191191
podDisruptionBudget:
192192
enabled: false
193193
maxUnavailable: 1
@@ -423,7 +423,7 @@ spec:
423423
registry: ghcr.io/huggingface
424424
repository: text-embeddings-inference
425425
useGpu: true
426-
serviceMonitor: false
426+
serviceMonitor: true
427427
tolerations:
428428
- key: "gpu-node"
429429
operator: "Exists"
@@ -437,7 +437,7 @@ spec:
437437
revision: main
438438
useGpu: true
439439
args: ["--pooling", "splade"]
440-
serviceMonitor: false
440+
serviceMonitor: true
441441
tolerations:
442442
- key: "gpu-node"
443443
operator: "Exists"
@@ -450,7 +450,7 @@ spec:
450450
revision: main
451451
useGpu: true
452452
args: ["--pooling", "splade"]
453-
serviceMonitor: false
453+
serviceMonitor: true
454454
tolerations:
455455
- key: "gpu-node"
456456
operator: "Exists"
@@ -463,7 +463,7 @@ spec:
463463
revision: main
464464
useGpu: true
465465
args: []
466-
serviceMonitor: false
466+
serviceMonitor: true
467467
tolerations:
468468
- key: "gpu-node"
469469
operator: "Exists"
@@ -476,7 +476,7 @@ spec:
476476
revision: refs/pr/4
477477
useGpu: true
478478
args: []
479-
serviceMonitor: false
479+
serviceMonitor: true
480480
tolerations:
481481
- key: "gpu-node"
482482
operator: "Exists"

charts/trieve/README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,15 +36,17 @@ Before proceeding, you need to modify these specific sections in your `values.ya
3636
1. **config.vite** - Domains that the frontends use URLs (apiHost, searchUiUrl, chatUiUrl, dashboardUrl)
3737
2. **config.trieve.baseServerUrl** - Domain that the server uses
3838
3. **config.trieve** security keys:
39-
- `salt` - Generate with: `openssl rand -hex 16`
40-
- `secretKey` - Generate with: `openssl rand -hex 32`
41-
- `adminApiKey` - Generate with: `openssl rand -hex 24`
39+
- `adminApiKey` - Generate with: `openssl rand -hex 24` (**config.trieve.adminApiKeyRef** to configure as a secret)
4240
4. **config.s3** - Your S3 bucket credentials (endpoint, accessKey, secretKey, bucket, region)
43-
5. **config.llm.apiKey** - Your OpenRouter API key
44-
6. **config.openai.apiKey** - Your OpenAI API key
41+
- **config.s3.accessKeyRef** To configure as a secret using the `config.s3.accessKeyRef` option
42+
- **config.s3.secretKey** To configure as a secret using the `config.s3.secretKeyRef` option
43+
5. **config.llm.apiKey** - Your OpenRouter API key (**config.llm.apiKeyRef** to configure as a secret)
44+
6. **config.openai.apiKey** - Your OpenAI API key (**config.openai.apiKeyRef** to configure as a secret)
4545
7. **config.oidc** - Your OIDC provider settings (clientSecret, clientId, issuerUrl, authRedirectUrl)
46-
8. **pdf2md.config.s3** - S3 credentials for PDF processing (if using PDF2MD)
46+
- `config.oidc.clientSecretRef` can be used to configure as a secret
47+
8. **pdf2md.s3** - S3 credentials for PDF processing (if using PDF2MD (`pdf2md.enabled`)
4748
9. **pdf2md.config.llm.apiKey** - LLM API key for PDF processing (if using PDF2MD)
49+
- `pdf2md.config.llm.apiKeyRef` can be used to configure as a secret
4850

4951
**For production**: Also change database passwords for clickhouse, qdrant, and redis.
5052

Lines changed: 33 additions & 102 deletions
Original file line numberDiff line numberDiff line change
@@ -1,102 +1,33 @@
1-
# This file provides examples of how to structure your Kubernetes Secrets
2-
# if you choose to use secretKeyRef for sensitive values in your values.yaml.
3-
4-
# Example for OIDC Client Secret
5-
# apiVersion: v1
6-
# kind: Secret
7-
# metadata:
8-
# name: my-oidc-client-secret
9-
# namespace: <your-namespace> # Replace with the namespace where Trieve is deployed
10-
# type: Opaque
11-
# data:
12-
# oidcClientSecretKey: "<your-base64-encoded-oidc-client-secret>" # echo -n "yourActualClientSecret" | base64
13-
14-
# Example for SMTP Password
15-
# apiVersion: v1
16-
# kind: Secret
17-
# metadata:
18-
# name: my-smtp-credentials
19-
# namespace: <your-namespace>
20-
# type: Opaque
21-
# data:
22-
# smtpPasswordKey: "<your-base64-encoded-smtp-password>"
23-
24-
# Example for Main LLM API Key (config.llm.apiKey)
25-
# apiVersion: v1
26-
# kind: Secret
27-
# metadata:
28-
# name: my-main-llm-apikey
29-
# namespace: <your-namespace>
30-
# type: Opaque
31-
# data:
32-
# llmApiKey: "<your-base64-encoded-llm-api-key>"
33-
34-
# Example for OpenAI API Key (config.openai.apiKey)
35-
# apiVersion: v1
36-
# kind: Secret
37-
# metadata:
38-
# name: my-openai-apikey
39-
# namespace: <your-namespace>
40-
# type: Opaque
41-
# data:
42-
# openaiApiKey: "<your-base64-encoded-openai-api-key>"
43-
44-
# Example for S3 Access Key
45-
# apiVersion: v1
46-
# kind: Secret
47-
# metadata:
48-
# name: my-s3-access-key
49-
# namespace: <your-namespace>
50-
# type: Opaque
51-
# data:
52-
# s3AccessKey: "<your-base64-encoded-s3-access-key>"
53-
54-
# Example for S3 Secret Key
55-
# apiVersion: v1
56-
# kind: Secret
57-
# metadata:
58-
# name: my-s3-secret-key
59-
# namespace: <your-namespace>
60-
# type: Opaque
61-
# data:
62-
# s3SecretKey: "<your-base64-encoded-s3-secret-key>"
63-
64-
# Example for PDF2MD Service API Key (pdf2md.config.pdf2md.apiKey)
65-
# apiVersion: v1
66-
# kind: Secret
67-
# metadata:
68-
# name: my-pdf2md-apikey
69-
# namespace: <your-namespace>
70-
# type: Opaque
71-
# data:
72-
# pdf2mdApiKey: "<your-base64-encoded-pdf2md-api-key>"
73-
74-
# Example for Trieve Admin API Key (config.trieve.adminApiKey)
75-
# apiVersion: v1
76-
# kind: Secret
77-
# metadata:
78-
# name: my-trieve-admin-apikey
79-
# namespace: <your-namespace>
80-
# type: Opaque
81-
# data:
82-
# adminApiKey: "<your-base64-encoded-trieve-admin-api-key>"
83-
84-
# --- Instructions ---
85-
# 1. Replace <your-namespace> with the actual namespace.
86-
# 2. Replace <your-base64-encoded-value> with the base64 encoded version of your secret.
87-
# You can generate this using: echo -n "yourActualSecretValue" | base64
88-
# 3. Uncomment the sections you need and save this file (or a similar one) with your actual secrets.
89-
# 4. Apply this secret manifest to your Kubernetes cluster: kubectl apply -f your_secrets_file.yaml
90-
# 5. Update your Trieve Helm chart's values.yaml to reference these secrets, for example:
91-
# config:
92-
# oidc:
93-
# clientSecretRef:
94-
# enabled: true
95-
# secretName: "my-oidc-client-secret"
96-
# secretKey: "oidcClientSecretKey"
97-
# llm:
98-
# apiKeyRef:
99-
# enabled: true
100-
# secretName: "my-main-llm-apikey"
101-
# secretKey: "llmApiKey"
102-
# # ... and so on for other secrets
1+
apiVersion: v1
2+
kind: Secret
3+
metadata:
4+
name: trieve-unified-secret
5+
namespace: trieve # Ensure this is the correct namespace
6+
stringData:
7+
# LLM API Keys
8+
# openrouter.ai api key (optional)
9+
llmApiKey:
10+
# OpenAI api key
11+
openaiApiKey:
12+
13+
# S3 Credentials (ensure you also update s3.endpoint, s3.region, s3.bucket in values.yaml)
14+
s3AccessKey:
15+
s3SecretKey:
16+
17+
# Other API Keys
18+
adminApiKey:
19+
# jina code api key (optional for jina-code embedding model)
20+
jinaCodeApiKey: jina_************************************************************
21+
22+
# OIDC and Database
23+
oidcClientSecret:
24+
25+
clickhousePassword: clickhouse
26+
27+
# SMTP
28+
smtpPassword: ""
29+
30+
redisPassword: "moreComplexPassword"
31+
redisUrl: "redis://:moreComplexPassword@trieve-local-redis-master:6379"
32+
33+
pdf2mdInternalAuth: "pdf2mdPassword"

charts/trieve/values.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ config:
353353
rerankerServerOrigin: http://embedding-reranker.default.svc.cluster.local
354354
salt: "tbbqfnygvfirellhzzl" # Should be a unique random string
355355
secretKey: "lkjadsf2349asdlfkj2334209ualkfsdlfkj1023u19312l3kj12l3kjsaf0d9u90823l1kj3209u34h" # Should be a unique random string
356-
adminApiKey: "" # Example: "ad91lkjad190adfal"
356+
adminApiKey: "adminApiKey" # Example: "ad91lkjad190adfal"
357357
adminApiKeyRef:
358358
enabled: false
359359
secretName: "my-admin-api-key-secret"

0 commit comments

Comments
 (0)