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 new zip for example SAML configuration files that reflect latest version #3665

Merged
merged 6 commits into from
Jul 6, 2023

Conversation

cwillum
Copy link
Contributor

@cwillum cwillum commented Apr 4, 2023

Description

These changes add a new saml-example-custom.zip file containing customize-docker-compose.yml, customize-config.yml, and customize-opensearch-dashboards.yml files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

The opensearch-dashboards.yml file contains the server.xsrf.allowlist setting. For version 1.3 this setting must remain server.xsrf.whitelist to conform to code for that version. Therefore, I'll create a new PR for that download. This PR covers versions 2.x and should work for subsequent major releases.

Issues Resolved

Fixes #618

Checklist

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

…version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.
@cwillum cwillum added 2 - In progress Issue/PR: The issue or PR is in progress. backport 1.3 PR: Backport label for v1.3.x backport 2.0 PR: Backport label for v2.0.x security backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 labels Apr 4, 2023
@cwillum cwillum requested a review from a team as a code owner April 4, 2023 18:24
@cwillum cwillum self-assigned this Apr 4, 2023
@cwillum cwillum removed the backport 1.3 PR: Backport label for v1.3.x label Apr 4, 2023
@cwillum
Copy link
Contributor Author

cwillum commented Apr 5, 2023

Since we can't view the contents of the zip file here in GitHub, I'm pasting the note I added to the image settings in the docker-compose.yml file directing users to change the version number. The steps also include instruction to perform this edit. But I'm pasting the note in the file here for visibility and for review:

image: opensearchproject/opensearch:latest # replace "latest" with your preferred OpenSearch version number before launching in production: for example, 2.6.0.

@cwillum
Copy link
Contributor Author

cwillum commented Apr 5, 2023

@opensearch-project/security I'm trying to resolve this issue with the SAML example zip file getting stale with each new version release. I've added steps to have users modify the docker-compose.yml file after download with OpenSearch version number in the proper image fields. I also added comments in the YAML file instructing users to do the same. The comment in the docker-compose.yml file looks like this:

image: opensearchproject/opensearch:latest # replace "latest" with your preferred OpenSearch version number before launching in production: for example, 2.6.0.

Could you have a look at this edit and see if it looks and sounds accurate/makes sense. Thanks.

Copy link
Member

@peternied peternied left a comment

Choose a reason for hiding this comment

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

I wouldn't recommend the tag latest, instead lets use 2. This will point to whatever the latest v2.X.X version of OpenSearch that has been released, this should ensure this client will always startup with modifying these instructions.

@Naarcha-AWS Naarcha-AWS merged commit 07c4019 into main Jul 6, 2023
@Naarcha-AWS Naarcha-AWS deleted the fix#618-saml-config-example branch July 6, 2023 21:59
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 6, 2023
…version (#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 07c4019)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 6, 2023
…version (#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 07c4019)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 6, 2023
…version (#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 07c4019)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 6, 2023
…version (#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 07c4019)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 6, 2023
…version (#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 07c4019)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 6, 2023
…version (#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 07c4019)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
opensearch-trigger-bot bot pushed a commit that referenced this pull request Jul 6, 2023
…version (#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
(cherry picked from commit 07c4019)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Naarcha-AWS added a commit that referenced this pull request Jul 6, 2023
…version (#3665) (#4521)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* Apply suggestions from code review



---------




(cherry picked from commit 07c4019)

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <[email protected]>
Naarcha-AWS added a commit that referenced this pull request Jul 6, 2023
…version (#3665) (#4524)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* Apply suggestions from code review



---------




(cherry picked from commit 07c4019)

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <[email protected]>
Naarcha-AWS added a commit that referenced this pull request Jul 6, 2023
…version (#3665) (#4523)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* Apply suggestions from code review



---------




(cherry picked from commit 07c4019)

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <[email protected]>
Naarcha-AWS added a commit that referenced this pull request Jul 6, 2023
…version (#3665) (#4522)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* Apply suggestions from code review



---------




(cherry picked from commit 07c4019)

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <[email protected]>
Naarcha-AWS added a commit that referenced this pull request Jul 6, 2023
…version (#3665) (#4520)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* Apply suggestions from code review



---------




(cherry picked from commit 07c4019)

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <[email protected]>
Naarcha-AWS added a commit that referenced this pull request Jul 6, 2023
…version (#3665) (#4519)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* Apply suggestions from code review



---------




(cherry picked from commit 07c4019)

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <[email protected]>
Naarcha-AWS added a commit that referenced this pull request Jul 6, 2023
…version (#3665) (#4518)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* fix#618 saml example download



* Apply suggestions from code review



---------




(cherry picked from commit 07c4019)

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <[email protected]>
vagimeli pushed a commit that referenced this pull request Jul 12, 2023
…version (#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
vagimeli added a commit that referenced this pull request Jul 12, 2023
harshavamsi pushed a commit to harshavamsi/documentation-website that referenced this pull request Oct 31, 2023
…version (opensearch-project#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
vagimeli pushed a commit that referenced this pull request Dec 21, 2023
…version (#3665)

* Add new zip for example SAML configuration files that reflect latest version

These changes add a new saml-example-custom.zip file containing `customize-docker-compose.yml`, `customize-config.yml`, and `customize-opensearch-dashboards.yml` files for use as the fully functioning SAML example. These changes also include edits to documentation so that steps accord with the new files.

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* fix#618 saml example download

Signed-off-by: cwillum <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: cwillum <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2 - In progress Issue/PR: The issue or PR is in progress. backport 2.0 PR: Backport label for v2.0.x backport 2.1 PR: Backport label for 2.1 backport 2.2 PR: Backport label for 2.2 backport 2.3 PR: Backport label for 2.3 backport 2.4 PR: Backport label for 2.4 backport 2.5 PR: Backport label for 2.5 backport 2.6 PR: Backport label for 2.6 security
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Security saml-example is using docker-compose file pointed to 1.0.1
3 participants