Rename saml-metadata

This commit renames saml-metadata to elasticsearch-saml-metadata.
This commit is contained in:
Jason Tedor 2018-04-11 11:31:53 -04:00 committed by Ryan Ernst
parent 8a8a1dfc2e
commit 2d3fac307a
5 changed files with 11 additions and 11 deletions

View File

@ -2,15 +2,15 @@
[[saml-metadata]] [[saml-metadata]]
== saml-metadata == saml-metadata
The `saml-metadata` command can be used to generate a SAML 2.0 Service Provider The `elasticsearch-saml-metadata` command can be used to generate a SAML 2.0 Service
Metadata file. Provider Metadata file.
[float] [float]
=== Synopsis === Synopsis
[source,shell] [source,shell]
-------------------------------------------------- --------------------------------------------------
bin/x-pack/saml-metadata bin/elasticsearch-saml-metadata
[--realm <name>] [--realm <name>]
[--out <file_path>] [--batch] [--out <file_path>] [--batch]
[--attribute <name>] [--service-name <name>] [--attribute <name>] [--service-name <name>]
@ -28,8 +28,8 @@ bin/x-pack/saml-metadata
The SAML 2.0 specification provides a mechanism for Service Providers to The SAML 2.0 specification provides a mechanism for Service Providers to
describe their capabilities and configuration using a _metadata file_. describe their capabilities and configuration using a _metadata file_.
The `saml-metadata` command generates such a file, based on the configuration of The `elasticsearch-saml-metadata` command generates such a file, based on the
a SAML realm in {es}. configuration of a SAML realm in {es}.
Some SAML Identity Providers will allow you to automatically import a metadata Some SAML Identity Providers will allow you to automatically import a metadata
file when you configure the Elastic Stack as a Service Provider. file when you configure the Elastic Stack as a Service Provider.
@ -109,7 +109,7 @@ The following command generates a default metadata file for the `saml1` realm:
[source, sh] [source, sh]
-------------------------------------------------- --------------------------------------------------
bin/x-pack/saml-metadata --realm saml1 bin/elasticsearch-saml-metadata --realm saml1
-------------------------------------------------- --------------------------------------------------
The file will be written to `saml-elasticsearch-metadata.xml`. The file will be written to `saml-elasticsearch-metadata.xml`.
@ -122,7 +122,7 @@ The following command generates a metadata file for the `saml2` realm, with a
[source, sh] [source, sh]
-------------------------------------------------- --------------------------------------------------
bin/x-pack/saml-metadata --realm saml2 \ bin/elasticsearch-saml-metadata --realm saml2 \
--service-name kibana-finance \ --service-name kibana-finance \
--locale en-GB \ --locale en-GB \
--contacts \ --contacts \

View File

@ -577,9 +577,9 @@ Provider. This will automatically configure many of the integration options
between the IdP and the SP. between the IdP and the SP.
The Elastic Stack supports generating such a metadata file using the The Elastic Stack supports generating such a metadata file using the
`bin/x-pack/saml-metadata` command in your {es} directory. `bin/elasticsearch-saml-metadata` command in your {es} directory.
The {ref}/saml-metadata.html[documentation for the saml-metadata utility] The {ref}/saml-metadata.html[documentation for the elasticsearch-saml-metadata utility]
describes how to run it, and the available command line options. describes how to run it, and the available command line options.
[[saml-role-mapping]] [[saml-role-mapping]]

View File

@ -22,8 +22,8 @@ verify_xpack_installation() {
'elasticsearch-croneval.bat' 'elasticsearch-croneval.bat'
'migrate' 'migrate'
'migrate.bat' 'migrate.bat'
'saml-metadata' 'elasticsearch-saml-metadata'
'saml-metadata.bat' 'elasticsearch-saml-metadata.bat'
'elasticsearch-setup-passwords' 'elasticsearch-setup-passwords'
'elasticsearch-setup-passwords.bat' 'elasticsearch-setup-passwords.bat'
'elasticsearch-sql-cli' 'elasticsearch-sql-cli'