update to proxy v0.4.5 (#2)

amplitude · Mar 1, 2024 · 095ac13 · 095ac13
1 parent 887068a
commit 095ac13
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -28,23 +28,20 @@ The chart's `evaluationProxy` value contents exactly match the evaluation proxy'
 evaluationProxy:
   # At least one project is required.
   projects:
-    - id: "TODO"
-      apiKey: "TODO"
+    - apiKey: "TODO"
       secretKey: "TODO"
-      deploymentKeys:
-        - "TODO"
+      managementKey: "TODO"
   configuration: {}
 #    redis:
 #      uri: "redis://redis-master.default.svc.cluster.local:6379"
 ```
 
-| Value                     | Description                                                                                                                                                                                                                      |
-|---------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `projects.id`             | The Amplitude project ID. Can be found in the project's settings in Amplitude.                                                                                                                                                   |
-| `projects.apiKey`         | The project's API key. Can be found in the project's settings in Amplitude.                                                                                                                                                      |
-| `projects.secretKey`      | The project's secret key. Can be found in the project's settings in Amplitude.                                                                                                                                                   |
-| `projects.deploymentKeys` | The deployment keys to manage. Listed deployment keys have associated flags and cohorts downloaded and managed by the proxy. The deployment keys listed here must be associated with the project identified in the other fields. |
-| `configuration.redis.uri` | The uri for connecting to redis within the cluster. If missing, the proxy will run in memory.                                                                                                                                    |
+| Value                     | Description                                                                                                                                                                             |
+|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `projects.apiKey`         | The project's API key. Can be found in the project's settings in Amplitude.                                                                                                             |
+| `projects.secretKey`      | The project's secret key. Can be found in the project's settings in Amplitude.                                                                                                          |
+| `projects.managementKey`  | The Experiment management api key. Must be created for the same project as the configured API and secret key. Used to automatically access and update deployments used for the project. |
+| `configuration.redis.uri` | The uri for connecting to redis within the cluster. If missing, the proxy will run in memory.                                                                                           |
 
 ### Install chart
 

diff --git a/charts/evaluation-proxy/Chart.yaml b/charts/evaluation-proxy/Chart.yaml
@@ -9,10 +9,10 @@ sources:
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.1.1
+version: 0.2.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "0.2.0"
+appVersion: "0.4.5"
diff --git a/example/README.md b/example/README.md
@@ -18,10 +18,9 @@ helm install -f redis-values.yaml redis bitnami/redis
 ## Configure `values.yaml`
 
 Update the fields in the `values.yaml` file:
-1. `projects.id`: The Amplitude project ID. Can be found in the project's settings in Amplitude.
-2. `projects.apiKey`: The project's API key. Can be found in the project's settings in Amplitude.
-3. `projects.secretKey`: The project's secret key. Can be found in the project's settings in Amplitude.
-4. `projects.deploymentKeys`: The deployment keys to manage. Listed deployment keys have associated flags and cohorts downloaded and managed by the proxy. The deployment keys listed here must be associated with the project identified in the other fields.
+1. `projects.apiKey`: The project's API key. Can be found in the project's settings in Amplitude.
+2. `projects.secretKey`: The project's secret key. Can be found in the project's settings in Amplitude.
+3. `projects.managementKey`: The Experiment management api key. Must be created for the same project as the configured API and secret key. Used to automatically access and update deployments used for the project.
 
 ## Install Evaluation Proxy Helm Chart
 

diff --git a/example/values.yaml b/example/values.yaml
@@ -1,10 +1,8 @@
 evaluationProxy:
   projects:
-    - id: "TODO"
-      apiKey: "TODO"
+    - apiKey: "TODO"
       secretKey: "TODO"
-      deploymentKeys:
-        - "TODO"
+      managementKey: "TODO"
   configuration:
     redis:
       uri: "redis://redis-master.default.svc.cluster.local:6379"