feat: Add stormforger to generated application
@@ -56,6 +56,12 @@ optimize for metrics with inherent trade-offs such as cost and performance.
Objectives correspond to metrics observed over the course of a trial,
for example: "p95-latency".
Reference: https://docs.stormforge.io/reference/application/v1alpha1/#objective
+`,
+
+ "stormForger": `
+StormForger contains additional configuration information to set up StormForge
+performance tests. This is only needed when using StormForger scenarios.
+Reference: https://docs.stormforge.io/reference/application/v1alpha1/#stormforger
`,
"ingress": `
@@ -109,6 +115,14 @@ Reference: https://docs.stormforge.io/reference/application/v1alpha1/#ingress
optimize: false # Reports on the metric while not explicitly optimizing for them`,
"ingress": "url: https://localhost # Specifies the entrypoint for your application.",
+
+ "stormForger": `org: myorg # The StormForger organization to use for performance testing
+ accessToken:
+ file: mytoken.jwt # Read in the StormForger jwt from a file
+ literal: mysupersecretgeneratedjwt # The raw StormForger JWT. Be mindful of the security implications of including the JWT here.
+ secretKeyRef: # Specify a reference to an in cluster secret and key
+ name: stormforger-service-accounts
+ key: myorg`,
}
)
@@ -160,7 +174,8 @@ func (f *DocumentationFilter) annotateApplication(app *yaml.RNode) error {
"parameters": "resources",
"scenarios": "parameters",
"objectives": "scenarios",
- "ingress": "objectives",
+ "stormForger": "objectives",
+ "ingress": "stormForger",
"": "ingress",
}
