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

Updated README.md for BigQuery to Elasticsearch template #298

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

suyograo
Copy link

Updated README.md for BigQuery to Elasticsearch template

Updated README.md for BigQuery to Elasticsearch template
@google-cla google-cla bot added the cla: yes The PR submitter has a CLA label Sep 27, 2021
@suyograo
Copy link
Author

@prathapreddy123 @Cherepushko FYI

@prathapreddy123 prathapreddy123 self-requested a review September 28, 2021 03:02

Pipeline flow is illustrated below:

![alt text](../img/bigquery-to-elasticsearch-dataflow.png "BigQuery to Elasticsearch pipeline flow")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Image doesn't reflect the existing flow as current template has only 3 steps

### Parameters

The template requires the following parameters:
* inputTableSpec: Table in BigQuery to read from in form of: my-project:my-dataset.my-table. Either this or query must be provided.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

inputTableSpec is also optional parameter since user can supply either query or inputTableSpec

@@ -61,7 +82,7 @@ echo '{
"image":"'${TARGET_GCR_IMAGE}'",
"metadata":{
"name":"BigQuery to Elasticsearch",
"description":"Replicates BigQuery data into an Elasticsearch index",
"description":"Ingests BigQuery data into an Elasticsearch index",
"parameters":[
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For below parameters isOptional should be changed to true
inputTableSpec, elasticsearchUsername, elasticsearchPassword

ApiKey should be added to Json spec as mandatory parameter

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @prathapreddy123,

I want to use this template by using the username and password and not use the API key. Are you aware of any approach in which I may be able to do it.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @Mandark-droid

If you would like to use username and password you can use elasticsearchUsername and elasticsearchPassword and pass dummy value to apiKey parameter. In the cases where username and password is provided along with apikey, username and password will take precedence

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @prathapreddy123 ,

I have already tried by passing the : as base64encoded string and also passing the username and password in the username and password field but still the job/pipeline fails to execute. Can you provide me with a sample glcoud command used to create the job using this template as you are suggesting.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prathapreddy123 Thanks I got it working by just passing a simple single space as apikey and passing the username and password.

@stale
Copy link

stale bot commented Apr 16, 2022

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Apr 16, 2022
@bvolpato
Copy link
Contributor

Hi @suyograo -- thanks for your contribution here. Same thing - we unfortunately ran behind on reviews, and the structure of the project changed a bit. Is there still interest in pursuing this change? We can work together on a plan to resolve conflicts + review the docs.

@github-actions github-actions bot removed the stale label Jul 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes The PR submitter has a CLA size/M
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants