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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions _security/authentication-backends/saml.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

1. Download and unzip [the example zip file]({{site.url}}{{site.baseurl}}/assets/examples/saml-example.zip).
1. At the command line, run `docker-compose up`.
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, specify the location of the files in your directory and run `docker-compose up`.
1. Review the files:

* `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.
* `config.yml` configures SAML for authentication.
* `customize-docker-compose.yml`: Defines two OpenSearch nodes, an OpenSearch Dashboards server, and a SAML server.
* `customize-opensearch_dashboards.yml`: Includes SAML settings for the default `opensearch_dashboards.yml` file.
* `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.
Expand Down
Binary file added assets/examples/saml-example-custom.zip
Binary file not shown.
Binary file removed assets/examples/saml-example.zip
Binary file not shown.