Skip to content

Commit d671521

Browse files
committed
Fixing docs
1 parent 6f6fdbc commit d671521

File tree

3 files changed

+6
-24
lines changed

3 files changed

+6
-24
lines changed

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ compile:
3131

3232
list:
3333
@$ echo "To work with patterns use: \n\t$$ make pattern <pattern-name> <list | deploy | synth | destroy>"
34-
@$ echo "Example:\n\t$$ make pattern fargate deploy \n\nPatterns: \n"
34+
@$ echo "Example:\n\t$$ make pattern single-new-eks-opensource-observability deploy \n\nPatterns: \n"
3535
@$ $(foreach pattern, $(formatted_pattern_names), echo "\t$(pattern)";)
3636

3737
mkdocs:

README.md

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -144,31 +144,13 @@ To create a new pattern, please follow these steps:
144144

145145
Example simple synchronous pattern:
146146
```typescript
147+
import SingleNewEksOpenSourceobservabilityConstruct from '../lib/single-new-eks-opensource-observability-construct';
147148
import { configureApp } from '../lib/common/construct-utils';
148-
import FargateConstruct from '../lib/fargate-construct';
149-
150-
new FargateConstruct(configureApp(), 'fargate'); // configureApp() will create app and configure loggers and perform other prep steps
151-
```
152-
153-
4. In some cases, patterns need to use async APIs. For example, they may rely on external secrets that you want to validate ahead of the pattern deployment.
154-
155-
Example async pattern:
156-
157-
```typescript
158-
import { configureApp, errorHandler } from '../lib/common/construct-utils';
159149

160150
const app = configureApp();
161151

162-
new NginxIngressConstruct().buildAsync(app, 'nginx').catch((e) => {
163-
errorHandler(app, "NGINX Ingress pattern is not setup. This maybe due to missing secrets for ArgoCD admin pwd.", e);
164-
});
165-
```
166-
167-
5. There are a few utility functions that can be used in the pattern implementation such as secret prevalidation. This function will fail if the corresponding secret is not defined, this preventing the pattern to deploy.
168-
169-
```typescript
170-
await prevalidateSecrets(NginxIngressConstruct.name, undefined, SECRET_ARGO_ADMIN_PWD);
171-
await prevalidateSecrets("my-pattern-name", 'us-east-1', 'my-secret-name'); //
152+
new SingleNewEksOpenSourceobservabilityConstruct(app, 'single-new-eks-opensource');
153+
// configureApp() will create app and configure loggers and perform other prep steps
172154
```
173155

174156
## Security

docs/patterns/single-new-eks-observability-accelerators/single-new-eks-opensource-observability.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ export AMG_API_KEY=$(aws grafana create-workspace-api-key \
7575
5. AWS Secrets Manager for GRAFANA API KEY: Update the Grafana API key secret in AWS Secrets using the above new Grafana API key. This will be referenced by Grafana Operator deployment of our solution to access Amazon Managed Grafana from Amazon EKS Cluster
7676

7777
```bash
78+
export API_KEY_SECRET_NAME="grafana-api-key"
7879
aws secretsmanager create-secret \
79-
--name grafana-api-key \
80-
--description "API Key of your Grafana Instance" \
80+
--secret-id $API_KEY_SECRET_NAME \
8181
--secret-string "${AMG_API_KEY}" \
8282
--region $AWS_REGION \
8383
--query ARN \

0 commit comments

Comments
 (0)