Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add validator bound to the CI and fix kamelets #185

Merged
merged 2 commits into from
Apr 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 53 additions & 0 deletions .github/workflows/validate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# ---------------------------------------------------------------------------
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
# The ASF licenses this file to You under the Apache License, Version 2.0
# (the "License"); you may not use this file except in compliance with
# the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ---------------------------------------------------------------------------

name: validate

on:
pull_request:
branches:
- main
paths-ignore:
- '**.adoc'
- 'KEYS'
- 'LICENSE'
- 'NOTICE'
push:
branches:
- main
paths-ignore:
- '**.adoc'
- 'KEYS'
- 'LICENSE'
- 'NOTICE'

jobs:
validate:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Install Go
uses: actions/setup-go@v1
with:
go-version: 1.13.x
- name: Run Validator
run: |
echo "Running Kamelet validator..."

cd script/validator
go run . ../../
2 changes: 1 addition & 1 deletion aws-kinesis-firehose-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ spec:
- region
properties:
streamName:
title: Stream name
title: Stream Name
description: The name of the stream we want to send to data to
type: string
accessKey:
Expand Down
2 changes: 1 addition & 1 deletion aws-s3-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ spec:
type: string
example: "http://another-s3-endpoint:9000"
autoCreateBucket:
title: Autocreate bucket
title: Autocreate Bucket
description: Setting the autocreation of the S3 bucket bucketName.
type: boolean
x-descriptors:
Expand Down
4 changes: 2 additions & 2 deletions aws-s3-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ spec:
description: The S3 Bucket name or ARN
type: string
deleteAfterRead:
title: Auto-delete objects
title: Auto-delete Objects
description: Delete objects after consuming them
type: boolean
x-descriptors:
Expand All @@ -47,7 +47,7 @@ spec:
type: string
example: eu-west-1
autoCreateBucket:
title: Autocreate bucket
title: Autocreate Bucket
description: Setting the autocreation of the S3 bucket bucketName.
type: boolean
x-descriptors:
Expand Down
2 changes: 1 addition & 1 deletion aws-sns-fifo-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ spec:
type: boolean
default: false
autoCreateTopic:
title: Autocreate topic
title: Autocreate Topic
description: Setting the autocreation of the SNS topic.
type: boolean
x-descriptors:
Expand Down
2 changes: 1 addition & 1 deletion aws-sns-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ spec:
type: string
example: eu-west-1
autoCreateTopic:
title: Autocreate topic
title: Autocreate Topic
description: Setting the autocreation of the SNS topic.
type: boolean
x-descriptors:
Expand Down
2 changes: 1 addition & 1 deletion aws-sqs-batch-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ spec:
type: string
example: eu-west-1
autoCreateQueue:
title: Autocreate queue
title: Autocreate Queue
description: Setting the autocreation of the SQS queue.
type: boolean
x-descriptors:
Expand Down
2 changes: 1 addition & 1 deletion aws-sqs-fifo-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ spec:
type: boolean
default: false
autoCreateQueue:
title: Autocreate queue
title: Autocreate Queue
description: Setting the autocreation of the SQS queue.
type: boolean
x-descriptors:
Expand Down
2 changes: 1 addition & 1 deletion aws-sqs-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ spec:
type: string
example: eu-west-1
autoCreateQueue:
title: Autocreate queue
title: Autocreate Queue
description: Setting the autocreation of the SQS queue.
type: boolean
x-descriptors:
Expand Down
6 changes: 3 additions & 3 deletions aws-sqs-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ spec:
properties:
queueNameOrArn:
title: Queue Name
description: The SQS Queue name or ARN
description: The SQS Queue Name or ARN
type: string
deleteAfterRead:
title: Auto-delete messages
title: Auto-delete Messages
description: Delete messages after consuming them
type: boolean
x-descriptors:
Expand All @@ -47,7 +47,7 @@ spec:
type: string
example: eu-west-1
autoCreateQueue:
title: Autocreate queue
title: Autocreate Queue
description: Setting the autocreation of the SQS queue.
type: boolean
x-descriptors:
Expand Down
6 changes: 3 additions & 3 deletions azure-eventhubs-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ spec:
description: The eventhubs namespace
type: string
eventhubName:
title: Eventhubs name
title: Eventhubs Name
description: The eventhub name
type: boolean
type: string
sharedAccessName:
title: Share access name
title: Share Access Name
description: EventHubs SAS key name
type: string
sharedAccessKey:
title: Share access key
title: Share Access Key
description: The key for EventHubs SAS key name
type: string
x-descriptors:
Expand Down
12 changes: 6 additions & 6 deletions azure-eventhubs-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,30 @@ spec:
description: The eventhubs namespace
type: string
eventhubName:
title: Eventhubs name
title: Eventhubs Name
description: The eventhub name
type: boolean
type: string
sharedAccessName:
title: Share access name
title: Share Access Name
description: EventHubs SAS key name
type: string
sharedAccessKey:
title: Share access key
title: Share Access Key
description: The key for EventHubs SAS key name
type: string
x-descriptors:
- urn:alm:descriptor:com.tectonic.ui:password
blobAccountName:
title: Azure Storage Blob account name
title: Azure Storage Blob Account Name
description: The name of the storage blob account to be use
type: string
blobContainerName:
title: Azure Storage Blob container name
title: Azure Storage Blob Container Name
description: The name of the storage blob container to be use
type: string
blobAccessKey:
title: Azure Storage Blob access key
title: Azure Storage Blob Access Key
description: The key for Azure Storage Blob service associated with the Blob account name
type: string
x-descriptors:
Expand Down
2 changes: 1 addition & 1 deletion azure-storage-blob-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ spec:
- accessKey
properties:
period:
title: Period between polls
title: Period between Polls
description: The interval between fetches to the Azure Storage Container in milliseconds
type: integer
default: 10000
Expand Down
2 changes: 1 addition & 1 deletion bitcoin-source.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ spec:
Provides a feed of the value of the Bitcoin compared to USDT using the Binance service.
properties:
period:
title: Period between updates
title: Period between Updates
description: The interval between updates in milliseconds
type: integer
default: 10000
Expand Down
4 changes: 2 additions & 2 deletions cassandra-sink.kamelet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ spec:
- keyspace
- username
- password
- query
- preparedStatement
properties:
host:
title: Host
Expand Down Expand Up @@ -53,7 +53,7 @@ spec:
type: string
default: ANY
preparedStatement:
title: The Prepared statement
title: Prepared Statement
description: The Prepared statement to execute against the Cassandra cluster table
type: string
dependencies:
Expand Down
13 changes: 4 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,13 @@

This section contains the Kamelet catalog website, auto-generated from the source Kamelets.

## Building

To generate the adoc and svg files for the website (you need `go`):

```
# From the /docs/generator directory
go run . ../../ ../modules/ROOT/
```

To preview the website:

```
# From the /docs directory
yarn preview
```

## Generator

The generator tool has been moved in the /script/generator directory
8 changes: 0 additions & 8 deletions docs/generator/go.mod

This file was deleted.

4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/aws-kinesis-firehose-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The following table summarizes the configuration options available for the `aws-
| *accessKey {empty}* *| Access Key| The access key obtained from AWS| string| |
| *region {empty}* *| AWS Region| The AWS region to connect to| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| |
| *streamName {empty}* *| Stream name| The name of the stream we want to send to data to| string| |
| *streamName {empty}* *| Stream Name| The name of the stream we want to send to data to| string| |
|===

NOTE: Fields marked with ({empty}*) are mandatory.
Expand Down Expand Up @@ -49,7 +49,7 @@ spec:
accessKey: "The Access Key"
region: "eu-west-1"
secretKey: "The Secret Key"
streamName: "The Stream name"
streamName: "The Stream Name"

----

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/aws-s3-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ The following table summarizes the configuration options available for the `aws-
| *bucketNameOrArn {empty}* *| Bucket Name| The S3 Bucket name or ARN.| string| |
| *region {empty}* *| AWS Region| The AWS region to connect to.| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS.| string| |
| autoCreateBucket| Autocreate bucket| Setting the autocreation of the S3 bucket bucketName.| boolean| `false`|
| autoCreateBucket| Autocreate Bucket| Setting the autocreation of the S3 bucket bucketName.| boolean| `false`|
| overrideEndpoint| Override Endpoint| Set the need for overidding the endpoint. This option needs to be used in combination with uriEndpointOverride.| boolean| `false`|
| uriEndpointOverride| Override Endpoint URI| Set the overriding uri endpoint. This option needs to be used in combination with overrideEndpoint option.| string| | `"http://another-s3-endpoint:9000"`
|===
Expand Down
4 changes: 2 additions & 2 deletions docs/modules/ROOT/pages/aws-s3-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ The following table summarizes the configuration options available for the `aws-
| *bucketNameOrArn {empty}* *| Bucket Name| The S3 Bucket name or ARN| string| |
| *region {empty}* *| AWS Region| The AWS region to connect to| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| |
| autoCreateBucket| Autocreate bucket| Setting the autocreation of the S3 bucket bucketName.| boolean| `false`|
| deleteAfterRead| Auto-delete objects| Delete objects after consuming them| boolean| `true`|
| autoCreateBucket| Autocreate Bucket| Setting the autocreation of the S3 bucket bucketName.| boolean| `false`|
| deleteAfterRead| Auto-delete Objects| Delete objects after consuming them| boolean| `true`|
|===

NOTE: Fields marked with ({empty}*) are mandatory.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/aws-sns-fifo-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following table summarizes the configuration options available for the `aws-
| *region {empty}* *| AWS Region| The AWS region to connect to| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| |
| *topicNameOrArn {empty}* *| Topic Name| The SNS Topic name or ARN| string| |
| autoCreateTopic| Autocreate topic| Setting the autocreation of the SNS topic.| boolean| `false`|
| autoCreateTopic| Autocreate Topic| Setting the autocreation of the SNS topic.| boolean| `false`|
| contentBasedDeduplication| Content-Based Deduplication| Use content-based deduplication (should be enabled in the SQS FIFO queue first)| boolean| `false`|
|===

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/aws-sns-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following table summarizes the configuration options available for the `aws-
| *region {empty}* *| AWS Region| The AWS region to connect to| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| |
| *topicNameOrArn {empty}* *| Topic Name| The SQS Topic name or ARN| string| |
| autoCreateTopic| Autocreate topic| Setting the autocreation of the SNS topic.| boolean| `false`|
| autoCreateTopic| Autocreate Topic| Setting the autocreation of the SNS topic.| boolean| `false`|
|===

NOTE: Fields marked with ({empty}*) are mandatory.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/aws-sqs-batch-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The following table summarizes the configuration options available for the `aws-
| *queueNameOrArn {empty}* *| Queue Name| The SQS Queue name or ARN| string| |
| *region {empty}* *| AWS Region| The AWS region to connect to| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| |
| autoCreateQueue| Autocreate queue| Setting the autocreation of the SQS queue.| boolean| `false`|
| autoCreateQueue| Autocreate Queue| Setting the autocreation of the SQS queue.| boolean| `false`|
|===

NOTE: Fields marked with ({empty}*) are mandatory.
Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/aws-sqs-fifo-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following table summarizes the configuration options available for the `aws-
| *queueNameOrArn {empty}* *| Queue Name| The SQS Queue name or ARN| string| |
| *region {empty}* *| AWS Region| The AWS region to connect to| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| |
| autoCreateQueue| Autocreate queue| Setting the autocreation of the SQS queue.| boolean| `false`|
| autoCreateQueue| Autocreate Queue| Setting the autocreation of the SQS queue.| boolean| `false`|
| contentBasedDeduplication| Content-Based Deduplication| Use content-based deduplication (should be enabled in the SQS FIFO queue first)| boolean| `false`|
|===

Expand Down
2 changes: 1 addition & 1 deletion docs/modules/ROOT/pages/aws-sqs-sink.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The following table summarizes the configuration options available for the `aws-
| *queueNameOrArn {empty}* *| Queue Name| The SQS Queue name or ARN| string| |
| *region {empty}* *| AWS Region| The AWS region to connect to| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| |
| autoCreateQueue| Autocreate queue| Setting the autocreation of the SQS queue.| boolean| `false`|
| autoCreateQueue| Autocreate Queue| Setting the autocreation of the SQS queue.| boolean| `false`|
|===

NOTE: Fields marked with ({empty}*) are mandatory.
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/ROOT/pages/aws-sqs-source.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ The following table summarizes the configuration options available for the `aws-
|===
| Property| Name| Description| Type| Default| Example
| *accessKey {empty}* *| Access Key| The access key obtained from AWS| string| |
| *queueNameOrArn {empty}* *| Queue Name| The SQS Queue name or ARN| string| |
| *queueNameOrArn {empty}* *| Queue Name| The SQS Queue Name or ARN| string| |
| *region {empty}* *| AWS Region| The AWS region to connect to| string| | `"eu-west-1"`
| *secretKey {empty}* *| Secret Key| The secret key obtained from AWS| string| |
| autoCreateQueue| Autocreate queue| Setting the autocreation of the SQS queue.| boolean| `false`|
| deleteAfterRead| Auto-delete messages| Delete messages after consuming them| boolean| `true`|
| autoCreateQueue| Autocreate Queue| Setting the autocreation of the SQS queue.| boolean| `false`|
| deleteAfterRead| Auto-delete Messages| Delete messages after consuming them| boolean| `true`|
|===

NOTE: Fields marked with ({empty}*) are mandatory.
Expand Down
Loading