Skip to content

Update Opensearch port requirements

Kent Japhet Ballon requested to merge kballon-master-patch-71972 into master

What does this MR do?

The current documentation around port requirement only mentions port 9200 which is usually the case for Elasticsearch. However if OpenSearch is used instead, using port 9200 can break the page as the Opensearch Service only supports port 80 and 443.

OpenSearch Service only accepts connections over port 80 (HTTP) or 443 (HTTPS).

If users unexpectedly use port 9200 initially, they can't change it in the UI anymore as the page will render 500 response. They will have to workaround this by updating the port using the rails console.

Related issues

Author's checklist

If you are a GitLab team member and only adding documentation, do not add any of the following labels:

  • ~"frontend"
  • ~"backend"
  • ~"type::bug"
  • ~"database"

These labels cause the MR to be added to code verification QA issues.

Reviewer's checklist

Documentation-related MRs should be reviewed by a Technical Writer for a non-blocking review, based on Documentation Guidelines and the Style Guide.

If you aren't sure which tech writer to ask, use roulette or ask in the #docs Slack channel.

  • If the content requires it, ensure the information is reviewed by a subject matter expert.
  • Technical writer review items:
    • Ensure docs metadata is present and up-to-date.
    • Ensure the appropriate labels are added to this MR.
    • Ensure a release milestone is set.
    • If relevant to this MR, ensure content topic type principles are in use, including:
      • The headings should be something you'd do a Google search for. Instead of Default behavior, say something like Default behavior when you close an issue.
      • The headings (other than the page title) should be active. Instead of Configuring GDK, say something like Configure GDK.
      • Any task steps should be written as a numbered list.
      • If the content still needs to be edited for topic types, you can create a follow-up issue with the docs-technical-debt label.
  • Review by assigned maintainer, who can always request/require the reviews above. Maintainer's review can occur before or after a technical writer review.

Merge request reports