Add new zip for example SAML configuration files that reflect latest 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 <cwmmoore@amazon.com>

* fix#618 saml example download

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#618 saml example download

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#618 saml example download

Signed-off-by: cwillum <cwmmoore@amazon.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: cwillum <cwmmoore@amazon.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
This commit is contained in:
Chris Moore 2023-07-06 14:59:26 -07:00 committed by GitHub
parent ebb315e525
commit 07c4019e33
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 23 additions and 5 deletions

View File

@ -19,13 +19,31 @@ This profile is meant for use with web browsers. It is not a general-purpose way
We provide a fully functional example that can help you understand how to use SAML with OpenSearch Dashboards. We provide a fully functional example that can help you understand how to use SAML with OpenSearch Dashboards.
1. Download and unzip [the example zip file]({{site.url}}{{site.baseurl}}/assets/examples/saml-example.zip). 1. Download [the example zip file]({{site.url}}{{site.baseurl}}/assets/examples/saml-example-custom.zip) to a preferred location in your directory and unzip it.
1. At the command line, run `docker-compose up`. 1. At the command line, specify the location of the files in your directory and run `docker-compose up`.
1. Review the files: 1. Review the files:
* `docker-compose.yml` defines two OpenSearch nodes, an OpenSearch Dashboards server, and a SAML server. * `customize-docker-compose.yml`: Defines two OpenSearch nodes, an OpenSearch Dashboards server, and a SAML server.
* `custom-opensearch_dashboards.yml` add a few SAML settings to the default `opensearch_dashboards.yml` file. * `customize-opensearch_dashboards.yml`: Includes SAML settings for the default `opensearch_dashboards.yml` file.
* `config.yml` configures SAML for authentication. * `customize-config.yml`: Configures SAML for authentication.
You can remove "customize" from the file names if you plan to modify and keep these files for production.
{: .tip }
1. In the `docker-compose.yml` file, specify your OpenSearch version number in the `image` field for nodes 1 and 2, and OpenSearch Dashboards server. For example, if you are running OpenSearch version 2.6, the `image` fields will resemble the following examples:
```yml
opensearch-saml-node1:
image: opensearchproject/opensearch:2.8.0
```
```yml
opensearch-saml-node2:
image: opensearchproject/opensearch:2.8.0
```
```yml
opensearch-saml-dashboards:
image: opensearchproject/opensearch-dashboards:2.8.0
```
1. Access OpenSearch Dashboards at [http://localhost:5601](http://localhost:5601){:target='\_blank'}. Note that OpenSearch Dashboards immediately redirects you to the SAML login page. 1. Access OpenSearch Dashboards at [http://localhost:5601](http://localhost:5601){:target='\_blank'}. Note that OpenSearch Dashboards immediately redirects you to the SAML login page.

Binary file not shown.

Binary file not shown.