DOCS-676: Resource ARN "*" description misleading
DOCS-677: Site Replication Recovery requires removing failed site first
MINIO-16268: Further simplify erasure set stripe calculation docs to avoid further confusion
Partially addresses #672
Adds two additional supported KMS vendors.
Does not document how to configure or use the two additional KMS
vendors.
Co-authored-by: Ravind Kumar <ravind@min.io>
Updates mc docs for
[RELEASE.2022-12-02T23-48-47Z](623de88abd)
and closes several issues:
- Adds `mc support callhome`
- Simplifies and moves `mc support logs` to `mc admin logs`
- Adds `mc support proxy` command
- Adds `mc admin replicate resync` command
Closes#655Closes#663Closes#644
Just a couple of link adjustments for the Prometheus doc.
- One link was broken due to a page move on the Prometheus side.
- Other is a request from Slack to add a link to Prometheus install.
- Only the external links are set to open in new windows/tab
- Fixed incorrect web-font paths being called for preload.
- Minor CSS transition fixes.
- Conditionally called the search modal's keyboard events.
Updates docs for various releases through November 2022.
## Updates for mc RELEASE.2022-11-17T21-20-39Z
- Creates `mc admin idp ldap policy entities` section
- Corrects incorrect `--tier` flag in `mc ilm add`
- Adds info to `mc ilm ls` about new tabular format of output
Closes#645
- Adds info about modifying endpoints for distributed endpoits.
Partially addresses #644
## Updates for Bugfix [minio
RELEASE.2022-11-29T23-40-49Z](https://github.com/minio/minio/releases/tag/RELEASE.2022-11-29T23-40-49Z)
- Adds information about the --remove flag dropping data directories as
well and running on a per-drive basis [PR
16122](https://github.com/minio/minio/pull/16122)
- Adds note that MinIO only supports one JWT based OpenID provider [PR
#16145](https://github.com/minio/minio/pull/16145)
Note: There was no Docs issue to track this release.
## Other fix:
- Minor correction to Admin Trace
- Clarifies that mc admin idp ldap policy entities command is
cumulative, not exclusive when using multiple flags
## Add additional `mc admin config` commands
- Adds three additional commands.
- Notes under several commands that environment variables override
config keys.
Closes#653
Policies can now include conditions for certain types of actions. If the
object has an existing tag, the user can complete the action. Otherwise,
the user cannot.
In the Access Management doc
- Adds a section near the top about tag based policies
- In the conditional section, adds `s3.ExistingObjectTag` as an allowed
conditional for several specific actions.
Closes#604
Adds warning about weak policy condition keys.
Closes#596
- Adds info on multiple IDPs and logging in to the MinIO Console
- Updates Configuration section of MinIO Console to Settings
- Adds info about validation check when creating a bucket
- Adds info about adding certificates when creating a tenant in the
operator
Closes#545
# Updates for Operator 4.5.0
- Add --interactive flag info to kubectl create tenant docs
- Adds flag to kubectl minio tenant create doc
- Softens wording on bucket limit to be recommended in the MinIO console
doc for PR#649
# Updates for Console v0.20.5
- Adds environment variable option to create tenant
- Creates Audit Log section to create tenant page and moves some options
there
# Updates for console v0.21.0
- Adding info about the tiers status column when in the console
- Reworking site replication section for new changes to the layout in
Console
- Skips documenting support for editing raw YAML for encryption page
when creating a tenant, as that seems to not be supported any longer
# Updates for operator 4.5.4
- Adds --pool flag to kubectl minio tenant create
- Adds --pool flag to kubectl minio tenant expand
Closes#634Closes#615Closes#590Closes#569
Applies changes in Operator 4.5.0 release.
- Adds flag to `kubectl minio tenant create` doc
- Softens wording on bucket limit to be recommended in the MinIO console
doc for PR#649
Closes#569
Doc updates related to for minio RELEASE.2022-08-22T23-53-06Z
- Adds note about idempotent delete markers, which diverges from
standard S3
- Adds info about queueing and re-attempting failed bucket replication
tasks
- Cleans up `mc ilm add` examples throughout the docs that did not
reflect recent flag name changes
- Adds a missing metric to Metrics and Alerts
Closes#537
Updates `mc` reference docs for several releases of the MinIO Client.
- Adds missing flags to `mc admin trace`
- Updates `disk` -> `drive` throughout the docs, but not in all cases.
- Adds `--airgap flag` to `mc support profile` and `mc support perf`
commands.
- Updates the flags for `mc ilm add` command
- Adds `mc license unregister` command.
Closes#571Closes#614Closes#627Closes#633
Changes to the docs related to mc
[RELEASE.2022-11-07T23-47-39Z](https://github.com/minio/mc/releases/tag/RELEASE.2022-11-07T23-47-39Z)
- Replaces `mc replicate edit` with `mc replicate update`
- Adds `mc admin idp oidc | ldap` commands
- Update to `mc support inspect` format
- Adds `mc admin rebalance` command
- Updates mc replicate edit references throughout docs to point to mc
replicate update.
- Adds a rebalance pools section to the expand deployment doc.
- Clarifies precedence for environment variables vs config settings.
Closes#636Closes#632
Found this typo while reading the documentation.
Not sure if this everything that is needed since i'm not familiar with
how docs are generated but hope this helps :)
Please close this PR if i'm missing something
- Utilizes mc admin cluster commands to export/import bucket and IAM
settings.
- Adds export and import to the mc admin config command reference doc.
- Applies additional feedback from #628 that was added after that PR was
merged.
Closes#624
Creates a new page under install-deploy-manage Operator docs. This page
summarizes the changes that led to the deprecation of the
Gateway/Filesystem. It overviews the steps required to create a new
Single-Node, Single-Drive deployment with the contents, settings, and
IAM policies from the old deployment.
# Summary
The default Markdown parser MyST provides doesn't seem to like the way
we've designed our SDK Markdown docs.
This change *should* enable github-strict parsing. It also adds
auto-headers to all H1s, which might resolve some of the TOC issues.
This gives us some breathing room to fixup the SDKs where we can still
allow for the files to look good in GitHub, but know they will render
properly on our Sphinx-built docs.
Closes#618
- Adds recommendation for pointing to a load balancer, reverse proxy, or similar for multi-node environments when creating aliases for site replication.
- Explains that this recommendation avoids a single point of failure risk.
- Updates tabs on site replication page to be in sync when a reader selects Command Line or Console instructions.
- Adds :sync: option example to the design doc.
Applies style changes to the `.guilabel` css class to better set off the
labels in the docs:
- Adds a pill box effect
- bolds the text
- Applies the `--theme-light-bg` color variable to the background
Corrections for build errors
- `mc ilm add` changed `storage-class` flags to `tier` instead. Updated
several pages with references to those flags.
- Corrects a bad reference in the `mc license info` doc to the minio
client page that was missing a hyphen.
Updates for mc release 2022-08-23
Closes#536
- Thoroughly updated the `mc ilm add` reference page and added --prefix and --newer** flags.
- Updates the `mc ilm edit` reference page to add the --prefix, --disable, and --enable flags.
- Adds `mc od` command
- Adds `--with-versioning` flag to `mc mb`
- Adds `--api-key` to `mc support diag`
- Adds clarification to --airgap flag on `mc license` and `mc support` topics that flag is not required if the local device has network access, even if the deployment is airgapped.
Closes#610
Did a QA pass after reports of some issues with the vault setup.
Identified an issue where my local testing was done with 0.20.0,
resulting in some errors on 0.21.0 due to dropping --mlock.
Also did a few other general tune ups as I ran end-to-ends again using
Vault + Systemd instead of vault in dev mode.
Staging views in #minio-docs channel
Closes#535
- Updates MinIO Console doc section on the Support tab
- Adds info to several pages that Prometheus metrics displayed in the
console can now be downloaded
- Adds that bucket notification targets can now be deleted from the
console
- Updates the MinIO Console page to reflect the current navigation
layout by moving around sections and updating screenshots
Closes#529
Release RELEASE.2022-08-11T04-37-28Z optimized when site healing
requeues.
Updated bucket replication and site replication docs to reflect this
change.
