Skip to content

Commit 0fdb0a7

Browse files
authored
updating the olm config file with proper documentation and examples (#11)
Updating the OLM config with proper info and examples. This ensures the bundle is created with proper `metadata.annotations.alm-examples` By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
1 parent 6a0b2ee commit 0fdb0a7

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

olm/olmconfig.yaml

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,20 @@
33
---
44
annotations:
55
capabilityLevel: Basic Install
6-
shortDescription: AWS Pipes controller is a service controller for managing Pipes resources
6+
shortDescription: AWS EventBridge Pipes controller is a service controller for managing Pipes resources
77
in Kubernetes
8-
displayName: AWS Controllers for Kubernetes - Amazon Pipes
8+
displayName: AWS Controllers for Kubernetes - Amazon EventBridge Pipes
99
description: |-
10-
Manage Amazon Pipes resources in AWS from within your Kubernetes cluster.
10+
Manage Amazon EventBridge Pipes resources in AWS from within your Kubernetes cluster.
1111
1212
13-
**About Amazon Pipes**
13+
**About Amazon EventBridge Pipes**
1414
1515
16-
{ADD YOUR DESCRIPTION HERE}
16+
Amazon EventBridge Pipes connects sources to targets. Pipes are intended for point-to-point integrations between supported [sources](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-source.html)
17+
and [targets](https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes-event-target.html), with support for advanced transformations and [enrichment](https://docs.aws.amazon.com/eventbridge/latest/userguide/pipes-enrichment.html).
18+
It reduces the need for specialized knowledge and integration code when developing event-driven architectures, fostering consistency across your company’s applications. To set up a pipe, you choose the source,
19+
add optional filtering, define optional enrichment, and choose the target for the event data.
1720
1821
1922
**About the AWS Controllers for Kubernetes**
@@ -28,13 +31,11 @@ description: |-
2831
2932
Please follow the following link: [Red Hat OpenShift](https://aws-controllers-k8s.github.io/community/docs/user-docs/openshift/)
3033
samples:
31-
- kind: ExampleCustomKind
32-
spec: '{}'
33-
- kind: SecondExampleCustomKind
34+
- kind: Pipe
3435
spec: '{}'
3536
maintainers:
3637
- name: "pipes maintainer team"
3738
email: "ack-maintainers@amazon.com"
3839
links:
39-
- name: Amazon Pipes Developer Resources
40-
url: https://aws.amazon.com/Pipes/developer-resources/
40+
- name: Amazon EventBridge Pipes Developer Resources
41+
url: https://aws.amazon.com/eventbridge/pipes/

0 commit comments

Comments
 (0)