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

Tutorial: Building a search engine on Kubernetes using Elasticsearch #28837

Closed
wants to merge 5 commits into from

Conversation

aravindputrevu
Copy link

@aravindputrevu aravindputrevu commented Jul 7, 2021

I'm adding a tutorial in the stateful-application section of Kubernetes Tutorials.
The tutorial explains how to build a search appliance on Kubernetes step by step with some screenshots for guidance.

@k8s-ci-robot
Copy link
Contributor

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.


  • If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
  • If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
  • If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
  • Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Jul 7, 2021
@k8s-ci-robot k8s-ci-robot added the language/en Issues or PRs related to English language label Jul 7, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign reylejano after the PR has been reviewed.
You can assign the PR to them by writing /assign @reylejano in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jul 7, 2021
@aravindputrevu
Copy link
Author

I have signed the CLA, just checking by changing the primary email.

@netlify
Copy link

netlify bot commented Jul 7, 2021

✔️ Deploy Preview for kubernetes-io-main-staging ready!

🔨 Explore the source changes: ee84844

🔍 Inspect the deploy log: https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/60e5bb0cbaf486000704eadd

😎 Browse the preview: https://deploy-preview-28837--kubernetes-io-main-staging.netlify.app

@aravindputrevu
Copy link
Author

@bradtopol / @zparnold - I have the same email in the CLA and commit, don't know what's wrong!

@WillsonHG
Copy link

/check-cla

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jul 7, 2021
Copy link
Contributor

@sftim sftim left a comment

Choose a reason for hiding this comment

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

Thanks for proposing this @aravindputrevu

It looks to me that this is documenting a specific technology (Elasticsearch). You could propose this tutorial for the Elasticsearch documentation instead; I think it would be a better fit there.

/hold
This doesn't seem to fit with the content guide

Comment on lines +13 to +15
{{< note >}}
The files provided in this tutorial are using GA Deployment APIs and are specific to kubernetes version 1.16 and 1.20. You can also try it on newer Kubernetes version but some APIs might throw deprecated warnings.
{{< /note >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Hi. These look like prerequisites - I'd mention them in the prerequisites section.


# Creating an Elasticsearch Cluster

There are many ways to run software like Elasticsearch on Kubernetes. For example, you could use the docker images or a helm chart. I’m using the official Kubernetes operator here.
Copy link
Contributor

Choose a reason for hiding this comment

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

There's no official Kubernetes operator - I'm concerned that this wording might suggest that the operator is endorsed by Kubernetes. What I think you're describing is the official Elasticsearch operator (for deploying onto Kubernetes) from Elastic.

2. Then, you will build a simple React-based search app using Kubernetes as a backend.


## {{% heading "prerequisites" %}}
Copy link
Contributor

Choose a reason for hiding this comment

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

How many nodes do you need? The tutorial doesn't make this clear.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Jul 9, 2021
@aravindputrevu
Copy link
Author

@sftim I was thinking that we could document about running stateful apps as elasticsearch is one. So please let me know if I need to remove anything to make it better.

@sftim
Copy link
Contributor

sftim commented Jul 9, 2021

#16618 is a discussion broadly on this topic (improving on the existing stateful app tutorial). Maybe make a suggestion there?

@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle stale
  • Mark this issue or PR as rotten with /lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

@k8s-ci-robot k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 7, 2021
@k8s-triage-robot
Copy link

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

  • After 90d of inactivity, lifecycle/stale is applied
  • After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
  • After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

  • Mark this issue or PR as fresh with /remove-lifecycle rotten
  • Close this issue or PR with /close
  • Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

@k8s-ci-robot k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Nov 6, 2021
@divya-mohan0209
Copy link
Contributor

/remove-lifecycle rotten

@k8s-ci-robot k8s-ci-robot removed the lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. label Dec 6, 2021
@divya-mohan0209
Copy link
Contributor

@aravindputrevu : Any progress on the issue/PR?

@aravindputrevu
Copy link
Author

@divya-mohan0209 I have asked the same in parent issue. I have received no update.

@k8s-ci-robot k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 10, 2022
@k8s-ci-robot
Copy link
Contributor

@aravindputrevu: PR needs rebase.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@reylejano
Copy link
Member

Hi @aravindputrevu , I agree that this PR on using Elasticsearch does not comply with the Kubernetes content guide and is better suited in the Elasticsearch documentation.

I'm closing this PR but feel free to reopen this PR if you feel otherwise and we can discuss further.
/close

@k8s-ci-robot
Copy link
Contributor

@reylejano: Closed this PR.

In response to this:

Hi @aravindputrevu , I agree that this PR on using Elasticsearch does not comply with the Kubernetes content guide and is better suited in the Elasticsearch documentation.

I'm closing this PR but feel free to reopen this PR if you feel otherwise and we can discuss further.
/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. language/en Issues or PRs related to English language needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants