feat: Add Meroxa workflows

warpdotdev · Aug 25, 2022 · 2ca0c81 · 2ca0c81
1 parent 98777eb
commit 2ca0c81
Show file tree

Hide file tree

Showing 10 changed files with 511 additions and 0 deletions.
diff --git a/specs/meroxa/resources_create_bigquery.yaml b/specs/meroxa/resources_create_bigquery.yaml
@@ -0,0 +1,45 @@
+---
+# The name of the workflow.
+name: Add a Google BigQuery resource to the Meroxa Platform
+# The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`.
+command: |-
+    meroxa resources create {{resource_name}} --type bigquery --url "bigquery://{{gcp_project_id}}/{{gcp_dataset_name}}" --client-key "$(cat {{gcp_service_account_json_file}})"
+# Any tags that the workflow should be categorized with.
+tags:
+  - meroxa
+  - data
+  - realtime
+# A description of the workflow.
+description: "Add a Google BigQuery resource to the Meroxa Platform using the following parameters:"
+# List of arguments within the command.
+arguments:
+    # Name of the argument within the command. This must exactly match the name of the argument
+    # within the command (without the curly braces).
+  - name: resource_name
+    # The description of the argument.
+    description: Name you want to use to identify this Google BigQuery resource
+    # The default value for the argument.
+    default_value: ~
+  - name: gcp_project_id
+    # The description of the argument.
+    description: Google Cloud Project ID
+    # The default value for the argument.
+    default_value: ~
+  - name: gcp_dataset_name
+    # The description of the argument.
+    description: Your BigQuery dataset name. GCP console will indicate your dataset ID as "project_id.dataset_name". Just include your dataset name here
+    # The default value for the argument.
+    default_value: bigquery://$GCP_PROJECT_ID/$GCP_DATASET_NAME
+  - name: gcp_service_account_json_file
+    # The description of the argument.
+    description: Google BigQuery Valid Service Account credentials with access to BigQuery in JSON format
+    # The default value for the argument.
+    default_value: ~
+# The source URL for where the workflow was generated from, if any.
+source_url: "https://docs.meroxa.com/platform/resources/google-bigquery#resource-configuration"
+# The author of the workflow.
+author: Meroxa
+# The URL of original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author_url` would be the StackOverflow author's profile page.
+author_url: "https://github.com/meroxa"
+# The valid shells where this workflow should be active. If valid for all shells, this can be left empty.
+# See FORMAT.md for the full list of accepted values.
diff --git a/specs/meroxa/resources_create_elasticsearch.yaml b/specs/meroxa/resources_create_elasticsearch.yaml
@@ -0,0 +1,52 @@
+---
+# The name of the workflow.
+name: Add an Elasticsearch resource to the Meroxa Platform
+# The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`.
+command: |-
+    meroxa resources create {{resource_name}} --type elasticsearch --url "https://{{es_username}}:{{es_password}}@{{es_url}}:{{es_port}}" --metadata '{"index.prefix": "{{es_index}}","incrementing.field.name": "{{es_incrementing_field}}"}'
+# Any tags that the workflow should be categorized with.
+tags:
+  - meroxa
+  - data
+  - realtime
+# A description of the workflow.
+description: "Add an Elasticsearch resource to the Meroxa Platform using the following parameters:"
+# List of arguments within the command.
+arguments:
+    # Name of the argument within the command. This must exactly match the name of the argument
+    # within the command (without the curly braces).
+  - name: resource_name
+    # The description of the argument.
+    description: Name you want to use to identify this resource
+    # The default value for the argument.
+    default_value: ~
+  - name: es_username
+    description: Elasticsearch Username
+  - name: es_password
+    description: Elasticsearch Password
+  - name: es_url
+    # The description of the argument.
+    description: Elasticsearch URL
+  - name: es_port
+    # The description of the argument.
+    description: "Elasticsearch port (e.g.: 9200)"
+    # The default value for the argument.
+    default_value: 9200
+  - name: es_index
+    # The description of the argument.
+    description: Elasticsearch Index
+    # The default value for the argument.
+    default_value: ~
+  - name: es_incrementing_field
+    # The description of the argument.
+    description: Elasticsearch Incremental Field (See View Context for more information) 
+    # The default value for the argument.
+    default_value: ~  
+# The source URL for where the workflow was generated from, if any.
+source_url: "https://docs.meroxa.com/platform/resources/elasticsearch#setup"
+# The author of the workflow.
+author: Meroxa
+# The URL of original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author_url` would be the StackOverflow author's profile page.
+author_url: "https://github.com/meroxa"
+# The valid shells where this workflow should be active. If valid for all shells, this can be left empty.
+# See FORMAT.md for the full list of accepted values.
diff --git a/specs/meroxa/resources_create_mongodb.yaml b/specs/meroxa/resources_create_mongodb.yaml
@@ -0,0 +1,46 @@
+---
+# The name of the workflow.
+name: Add a MongoDB resource to the Meroxa Platform
+# The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`.
+command: |-
+    meroxa resources create {{resource_name}} --type mongodb -u "mongodb://{{mongodb_username}}:{{mongodb_password}}@{{mongodb_url}}:{{mongodb_port}}"
+# Any tags that the workflow should be categorized with.
+tags:
+  - meroxa
+  - data
+  - realtime
+# A description of the workflow.
+description: "Add a MongoDB resource to the Meroxa Platform using the following parameters:"
+# List of arguments within the command.
+arguments:
+    # Name of the argument within the command. This must exactly match the name of the argument
+    # within the command (without the curly braces).
+  - name: resource_name
+    # The description of the argument.
+    description: Name you want to use to identify this resource
+    # The default value for the argument.
+    default_value: ~
+  - name: mongodb_username
+    # The description of the argument.
+    description: MongoDB Username
+    default_value: ~
+  - name: mongodb_password
+    # The description of the argument.
+    description: MongoDB Password
+    default_value: ~
+  - name: mongodb_url
+    # The description of the argument.
+    description: MongoDB URL
+    default_value: ~
+  - name: mongodb_port
+    # The description of the argument.
+    description: "MongoDB Port (e.g.: 27017)"
+    default_value: 27017
+# The source URL for where the workflow was generated from, if any.
+source_url: "https://docs.meroxa.com/platform/resources/mongodb#setup"
+# The author of the workflow.
+author: Meroxa
+# The URL of original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author_url` would be the StackOverflow author's profile page.
+author_url: "https://github.com/meroxa"
+# The valid shells where this workflow should be active. If valid for all shells, this can be left empty.
+# See FORMAT.md for the full list of accepted values.
diff --git a/specs/meroxa/resources_create_mysql.yaml b/specs/meroxa/resources_create_mysql.yaml
@@ -0,0 +1,55 @@
+---
+# The name of the workflow.
+name: Add a MySQL resource to the Meroxa Platform
+# The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`.
+command: |-
+    meroxa resources create {{resource_name}} --type mysql -u "mysql://{{mysql_username}}:{{mysql_password}}@{{mysql_url}}:{{mysql_port}}/{{mysql_database_name}}"
+# Any tags that the workflow should be categorized with.
+tags:
+  - meroxa
+  - data
+  - realtime
+# A description of the workflow.
+description: "Add a MySQL resource to the Meroxa Platform using the following parameters:"
+# List of arguments within the command.
+arguments:
+    # Name of the argument within the command. This must exactly match the name of the argument
+    # within the command (without the curly braces).
+  - name: resource_name
+    # The description of the argument.
+    description: Name you want to use to identify this resource
+    # The default value for the argument.
+    default_value: ~
+  - name: mysql_username
+    # The description of the argument.
+    description: MySQL Username
+    # The default value for the argument.
+    default_value: ~
+  - name: mysql_password
+    # The description of the argument.
+    description: MySQL Password
+    # The default value for the argument.
+    default_value: ~
+  - name: mysql_url
+    # The description of the argument.
+    description: MySQL URL
+    # The default value for the argument.
+    default_value: ~
+  - name: mysql_port
+    # The description of the argument.
+    description: "MySQL Port (e.g.:3306)"
+    # The default value for the argument.
+    default_value: 3306
+  - name: mysql_database_name
+    # The description of the argument.
+    description: MySQL database name
+    # The default value for the argument.
+    default_value: ~
+# The source URL for where the workflow was generated from, if any.
+source_url: "https://docs.meroxa.com/platform/resources/mysql/setup#resource-configuration"
+# The author of the workflow.
+author: Meroxa
+# The URL of original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author_url` would be the StackOverflow author's profile page.
+author_url: "https://github.com/meroxa"
+# The valid shells where this workflow should be active. If valid for all shells, this can be left empty.
+# See FORMAT.md for the full list of accepted values.
diff --git a/specs/meroxa/resources_create_postgres_with_logical_replication.yaml b/specs/meroxa/resources_create_postgres_with_logical_replication.yaml
@@ -0,0 +1,55 @@
+---
+# The name of the workflow.
+name: Add a Postgres resource with logical replication to the Meroxa Platform
+# The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`.
+command: |-
+    meroxa resources create {{resource_name}} --type postgres --url "postgres://{{pg_username}}:{{pg_password}}@{{pg_url}}:{{pg_port}}/{{pg_database_name}}" --metadata '{"logical_replication":"true"}'
+# Any tags that the workflow should be categorized with.
+tags:
+  - meroxa
+  - data
+  - realtime
+# A description of the workflow.
+description: "Add a Postgres resource with logical replication to the Meroxa Platform using the following parameters:"
+# List of arguments within the command.
+arguments:
+    # Name of the argument within the command. This must exactly match the name of the argument
+    # within the command (without the curly braces).
+  - name: resource_name
+    # The description of the argument.
+    description: Name you want to use to identify this resource
+    # The default value for the argument.
+    default_value: ~
+  - name: pg_username
+    # The description of the argument.
+    description: Postgres Username
+    # The default value for the argument.
+    default_value: ~
+  - name: pg_password
+    # The description of the argument.
+    description: Postgres Password
+    # The default value for the argument.
+    default_value: ~
+  - name: pg_url
+    # The description of the argument.
+    description: Postgres URL
+    # The default value for the argument.
+    default_value: ~
+  - name: pg_port
+    # The description of the argument.
+    description: "Postgres Port (e.g.: 5432)"
+    # The default value for the argument.
+    default_value: 5432
+  - name: pg_database_name
+    # The description of the argument.
+    description: Postgres Database name
+    # The default value for the argument.
+    default_value: ~
+# The source URL for where the workflow was generated from, if any.
+source_url: "https://docs.meroxa.com/platform/resources/postgresql/setup#resource-configuration"
+# The author of the workflow.
+author: Meroxa
+# The URL of original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author_url` would be the StackOverflow author's profile page.
+author_url: "https://github.com/meroxa"
+# The valid shells where this workflow should be active. If valid for all shells, this can be left empty.
+# See FORMAT.md for the full list of accepted values.
diff --git a/specs/meroxa/resources_create_postgres_without_logical_replication.yaml b/specs/meroxa/resources_create_postgres_without_logical_replication.yaml
@@ -0,0 +1,56 @@
+---
+# The name of the workflow.
+name: Add a Postgres resource to the Meroxa Platform without logical replication
+# The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`.
+command: |-
+    meroxa resources create {{resource_name}} --type postgres --url "postgres://{{pg_username}}:{{pg_password}}@{{pg_url}}:{{pg_port}}/{{pg_database_name}}" 
+# Any tags that the workflow should be categorized with.
+tags:
+  - meroxa
+  - data
+  - realtime
+# A description of the workflow.
+description: "Add a Postgres resource without logical replication to the Meroxa Platform using the following parameters:"
+# List of arguments within the command.
+arguments:
+    # Name of the argument within the command. This must exactly match the name of the argument
+    # within the command (without the curly braces).
+  - name: resource_name
+    # The description of the argument.
+    description: Name you want to use to identify this resource
+    # The default value for the argument.
+    default_value: ~
+  - name: pg_username
+    # The description of the argument.
+    description: Postgres Username
+    # The default value for the argument.
+    default_value: ~
+  - name: pg_password
+    # The description of the argument.
+    description: Postgres Password
+    # The default value for the argument.
+    default_value: ~
+  - name: pg_url
+    # The description of the argument.
+    description: Postgres URL
+    # The default value for the argument.
+    default_value: ~
+  - name: pg_port
+    # The description of the argument.
+    description: "Postgres Port (e.g.: 5432)"
+    # The default value for the argument.
+    default_value: 5432
+  - name: pg_database_name
+    # The description of the argument.
+    description: Postgres Database name
+    # The default value for the argument.
+    default_value: ~
+
+# The source URL for where the workflow was generated from, if any.
+source_url: "https://docs.meroxa.com/platform/resources/postgresql/setup#resource-configuration"
+# The author of the workflow.
+author: Meroxa
+# The URL of original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author_url` would be the StackOverflow author's profile page.
+author_url: "https://github.com/meroxa"
+# The valid shells where this workflow should be active. If valid for all shells, this can be left empty.
+# See FORMAT.md for the full list of accepted values.
diff --git a/specs/meroxa/resources_create_redshift.yaml b/specs/meroxa/resources_create_redshift.yaml
@@ -0,0 +1,55 @@
+---
+# The name of the workflow.
+name: Add an Amazon Redshift resource to the Meroxa Platform
+# The corresponding command for the workflow. Any arguments should be surrounded with two curly braces. E.g `command {{arg}}`.
+command: |-
+    meroxa resources create {{resource_name}} --type redshift --url "redshift://{{redshift_username}}:{{redshift_password}}@{{redshift_url}}:{{redshift_port}}/{{redshift_db_name}}"
+# Any tags that the workflow should be categorized with.
+tags:
+  - meroxa
+  - data
+  - realtime
+# A description of the workflow.
+description: "Add an Amazon Redshift resource to the Meroxa Platform using the following parameters:"
+# List of arguments within the command.
+arguments:
+    # Name of the argument within the command. This must exactly match the name of the argument
+    # within the command (without the curly braces).
+  - name: resource_name
+    # The description of the argument.
+    description: Name you want to use to identify this resource
+    # The default value for the argument.
+    default_value: ~
+  - name: redshift_username
+    # The description of the argument.
+    description: Redshift username
+    # The default value for the argument.
+    default_value: ~
+  - name: redshift_password
+    # The description of the argument.
+    description: Redshift password
+    # The default value for the argument.
+    default_value: ~
+  - name: redshift_url
+    # The description of the argument.
+    description: Redshift URL
+    # The default value for the argument.
+    default_value: ~
+  - name: redshift_port
+    # The description of the argument.
+    description: "Redshift Port (e.g.: 5439)"
+    # The default value for the argument.
+    default_value: 5439
+  - name: redshift_db_name
+    # The description of the argument.
+    description: "Redshift Database name"
+    # The default value for the argument.
+    default_value: ~
+# The source URL for where the workflow was generated from, if any.
+source_url: "https://docs.meroxa.com/platform/resources/amazon-redshift#setup"
+# The author of the workflow.
+author: Meroxa
+# The URL of original author of the Workflow. For example, if this workflow was generated from StackOverflow, the `author_url` would be the StackOverflow author's profile page.
+author_url: "https://github.com/meroxa"
+# The valid shells where this workflow should be active. If valid for all shells, this can be left empty.
+# See FORMAT.md for the full list of accepted values.