1
0
mirror of https://github.com/minio/docs.git synced 2025-07-31 18:04:52 +03:00

Move reference docs for mc admin idp commands to mc idp (#873)

All the `mc admin idp *` commands have been renamed `mc idp *`.
Deprecate everything under `mc admin idp` and create pages for their new
names in the MinIO Client section.

Affects the following commands and subcommands;
* `mc admin idp ldap`
* `mc admin idp openid`
*  `mc admin idp ldap policy`

The new pages maintain the existing content and page structure. New
pages for each subcommand are out of scope for this PR.

Partly addresses https://github.com/minio/docs/issues/859 and
https://github.com/minio/docs/issues/866

Staged:

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc.html

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-admin.html

http://192.241.195.202:9000/staging/DOCS-859-part-2-idp/linux/html/reference/minio-mc-deprecated.html

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
This commit is contained in:
Andrea Longo
2023-06-08 11:58:22 -06:00
committed by GitHub
parent 7f200b96b6
commit 4c735072f7
24 changed files with 942 additions and 45 deletions

View File

@ -275,5 +275,5 @@ Disable a Configured Active Directory / LDAP Connection
You can enable and disable the configured AD/LDAP connection as needed.
Use :mc-cmd:`mc admin idp ldap disable` to deactivate a configured connection.
Use :mc-cmd:`mc admin idp ldap enable` to activate a previously configured connection.
Use :mc-cmd:`mc idp ldap disable` to deactivate a configured connection.
Use :mc-cmd:`mc idp ldap enable` to activate a previously configured connection.

View File

@ -221,27 +221,27 @@ You can validate the functionality by using the Admin REST API with the MinIO cl
MinIO supports multiple methods for configuring Keycloak Admin API Support:
- Using a terminal/shell and the :mc:`mc admin idp openid` command
- Using a terminal/shell and the :mc:`mc idp openid` command
- Using environment variables set prior to starting MinIO
.. tab-set::
.. tab-item:: CLI
You can use the :mc-cmd:`mc admin idp openid update` command to modify the configuration settings for an existing Keycloak service.
You can use the :mc-cmd:`mc idp openid update` command to modify the configuration settings for an existing Keycloak service.
You can alternatively include the following configuration settings when setting up Keycloak for the first time.
The command takes all supported :ref:`OpenID Configuration Settings <minio-open-id-config-settings>`:
.. code-block:: shell
:class: copyable
mc admin idp openid update ALIAS KEYCLOAK_IDENTIFIER \
mc idp openid update ALIAS KEYCLOAK_IDENTIFIER \
vendor="keycloak" \
keycloak_admin_url="https://keycloak-url:port/admin"
keycloak_realm="REALM"
- Replace ``KEYCLOAK_IDENTIFIER`` with the name of the configured Keycloak IDP.
You can use :mc-cmd:`mc admin idp openid ls` to view all configured IDP configurations on the MinIO deployment
You can use :mc-cmd:`mc idp openid ls` to view all configured IDP configurations on the MinIO deployment
- Specify the Keycloak admin URL in the :mc-conf:`keycloak_admin_url <identity_openid.keycloak_admin_url>` configuration setting

View File

@ -419,7 +419,7 @@ To deploy a Tenant with Helm:
#. Expose the Tenant MinIO port
To test the MinIO Client :mc-cmd:`mc` from your local machine, forward the MinIO port and create an alias.
To test the MinIO Client :mc:`mc` from your local machine, forward the MinIO port and create an alias.
* Forward the Tenant's MinIO port: