From 2344cb304e4c1e24b84c573574e34d0d0fd93ece Mon Sep 17 00:00:00 2001 From: Ravind Kumar Date: Tue, 20 Sep 2022 12:33:16 -0400 Subject: [PATCH] Cleaning up build errors --- .../data-recovery/recover-after-site-failure.rst | 10 +++++----- .../multi-site-replication.rst | 2 +- source/operations/troubleshooting.rst | 16 ++++++++-------- .../minio-mc/mc-support-logs-enable.rst | 2 +- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/source/operations/data-recovery/recover-after-site-failure.rst b/source/operations/data-recovery/recover-after-site-failure.rst index 9e69dc69..aa8ef228 100644 --- a/source/operations/data-recovery/recover-after-site-failure.rst +++ b/source/operations/data-recovery/recover-after-site-failure.rst @@ -21,7 +21,7 @@ Site recovery depends on the replication option you use for the site. - Total restoration of IAM configurations, bucket configurations, and data from the healthy peer site(s) * - Bucket Replication - Data restoration of objects and metadata from a healthy remote location for each bucket configured for replication - * - :mc-cmd:`mc mirror` + * - :mc:`mc mirror` - Data restoration of objects only from a healthy remote location with no versioning Site Replication @@ -49,7 +49,7 @@ If you are switching from using bucket replication to using site replication, yo Active Bucket Replication Resynchronization ------------------------------------------- -For scenarios where :ref:`bucket replication ` was in place prior to the failure, you can use :mc-cmd:`mc replicate resync` to restore data to a new site. +For scenarios where :ref:`bucket replication ` was in place prior to the failure, you can use :mc:`mc replicate resync` to restore data to a new site. Create a new site to replace the failed deployment, then synchronize the data from an existing, healthy, bucket replication-enabled deployment to the new site. 1. Deploy a new MinIO site @@ -68,7 +68,7 @@ Passive Bucket Replication Resynchronization As a passive process, bucket replication may not perform as quickly as desired for a site recovery scenario. Using bucket replication relies on the standard replication scanner queue, which does not take priority over other processes. -For recovery procedures with stricter SLA/SLO, use the active bucket replication process with :mc-cmd:`mc replicate resync` command as described above. +For recovery procedures with stricter SLA/SLO, use the active bucket replication process with :mc:`mc replicate resync` command as described above. Bucket replication rules copy the object, its version ID, versions, and other metadata to the target bucket. MinIO can restore the object with all of these attributes to a new MinIO site if bucket replication had already been in use prior to the site loss. @@ -91,10 +91,10 @@ MinIO's mirroring copies an object from any S3 compatible storage system. Mirroring only copies the latest version of each object and does not include versioning metadata, regardless of the source. You cannot restore those attributes with this method. -Use :mc-cmd:`mc mirror` in situations where you need to restore only the latest version of an object. +Use :mc:`mc mirror` in situations where you need to restore only the latest version of an object. Use bucket replication or site replication where those methods were already in use if you are copying from another MinIO deployment and wish to restore the object's version history and version metadata. 1. Deploy a new MinIO site 2. Set up IAM and users as needed 3. Create buckets on the new site -4. Use the :mc-cmd:`mc cp` CLI command to copy the contents from the mirror location to the new MinIO site +4. Use the :mc:`mc cp` CLI command to copy the contents from the mirror location to the new MinIO site diff --git a/source/operations/install-deploy-manage/multi-site-replication.rst b/source/operations/install-deploy-manage/multi-site-replication.rst index 5f4d825a..02c28b7a 100644 --- a/source/operations/install-deploy-manage/multi-site-replication.rst +++ b/source/operations/install-deploy-manage/multi-site-replication.rst @@ -111,7 +111,7 @@ Switch to Site Replication from Bucket Replication You cannot use both replication methods on the same deployments. If you previously set up bucket replication and wish to now use site replication, you must first delete all of the bucket replication rules on the deployment that has data when initializing site replication. -Use :mc-cmd:`mc replicate rm` on the command line or the MinIO Console to remove bucket replication rules. +Use :mc:`mc replicate rm` on the command line or the MinIO Console to remove bucket replication rules. Only one site can have data when setting up site replication. All other sites must be empty. diff --git a/source/operations/troubleshooting.rst b/source/operations/troubleshooting.rst index 70e509ee..796cb922 100644 --- a/source/operations/troubleshooting.rst +++ b/source/operations/troubleshooting.rst @@ -69,9 +69,9 @@ Registering Your MinIO Deployment with SUBNET You can register for SUBNET from the command line. - Refer to :mc-cmd:`mc license register` for instructions. + Refer to :mc:`mc license register` for instructions. - For clusters without direct Internet access, refer to the instructions in the :ref:`airgap example ` of the :mc-cmd:`mc license register` documentation. + For clusters without direct Internet access, refer to the instructions in the :ref:`airgap example ` of the :mc:`mc license register` documentation. SUBNET Issues @@ -115,7 +115,7 @@ Deployment Health ~~~~~~~~~~~~~~~~~ The deployment's details include a summary of the deployment's configuration and the number of checks run and failed. -You can select :guilabel:`Upload` to add diagnostic health data obtained from the :mc-cmd:`mc support diag` command or the MinIO Console's Support > Health page. +You can select :guilabel:`Upload` to add diagnostic health data obtained from the :mc:`mc support diag` command or the MinIO Console's Support > Health page. If you need support from MinIO Engineering, you can create a :guilabel:`New Issue` for the deployment. @@ -145,7 +145,7 @@ If you registered the cluster with SUBNET, Performance and Inspection files can For clusters with an airgap, firewall, or otherwise blocked from SUBNET directly, you can manually upload files to SUBNET after logging in. -#. Generate the file(s) to upload from the command line with :mc-cmd:`mc support diag` or :mc-cmd:`mc support inspect` +#. Generate the file(s) to upload from the command line with :mc:`mc support diag` or :mc:`mc support inspect` #. Sign in to `SUBNET `_ #. Select :guilabel:`Deployments` #. Select :guilabel:`Diagnostics` @@ -160,11 +160,11 @@ For more details about encrypting or decrypting such files, see :ref:`Encrypting Logs ---- -Use the subcommands for ``mc support logs`` to :mc-cmd:`~mc support logs enable` or :mc-cmd:`~mc support logs disable` the submission of MinIO logs to SUBNET. -You can also use :mc-cmd:`mc support logs status` to check if a log submission is in progress. +Use the subcommands for ``mc support logs`` to :mc:`~mc support logs enable` or :mc:`~mc support logs disable` the submission of MinIO logs to SUBNET. +You can also use :mc:`mc support logs status` to check if a log submission is in progress. -Use :mc-cmd:`mc support logs show` command to display logs from the command line. -Use the parameter flags for the :mc-cmd:`mc support logs show` command to limit the displayed logs by type or quantity. +Use :mc:`mc support logs show` command to display logs from the command line. +Use the parameter flags for the :mc:`mc support logs show` command to limit the displayed logs by type or quantity. .. toctree:: :titlesonly: diff --git a/source/reference/minio-mc/mc-support-logs-enable.rst b/source/reference/minio-mc/mc-support-logs-enable.rst index a21d630e..b20cb58b 100644 --- a/source/reference/minio-mc/mc-support-logs-enable.rst +++ b/source/reference/minio-mc/mc-support-logs-enable.rst @@ -27,7 +27,7 @@ Use the :mc-cmd:`mc support logs enable` command to allow real-time MinIO logs t By default, MinIO does not scrub the logs uploaded to SUBNET. - To hide sensitive information in the logs, start the server with the :mc-cmd:`~mc server --anonymous` flag. + To hide sensitive information in the logs, start the server with the :mc-cmd:`~minio server --anonymous` flag. MinIO employs an aggressive scrubbing algorithm which may produce logs with reduced visibility into the deployment. MinIO Engineering may later request unredacted logs if required for ongoing support cases.