As per https://github.com/minio/console/issues/2539 , the websocket
behavior integrated as part of Console 0.22.1
(https://github.com/minio/console/pull/2419) seems to break
port-forwarding behavior.
There's no easy fix for this. NodePorts are a workaround, but slightly
kludgy. Ingress is the better long-term solution, but requires more
work.
This is a stopgap:
- For Operator, point users towards NodePorts if port-forwarding fails
- For Tenant Console, simply drop port-forwarding entirely and point
only at Ingress/LB
Out of scope but in progress is Ingress guidance for Nginx and Traefik
so we can close the loop on this.
- Adds landing pages for all two-word `mc` commands
- Nests three+ word commands under appropriate two-word commands
- Updates MinIO Client doc
- Uses description from each command to populate list of subcommand
descriptions
- Modifies toctree for MinIO Client doc and each command/subcommand to
improve left nav experienc
Closes#710
Updates related to [mc
RELEASE.2023-01-28T20-29-38Z](https://github.com/minio/mc/releases/tag/RELEASE.2023-01-28T20-29-38Z)
- new `--comment` flag for `mc admin user add` service accounts
- new `--airgap` flag for `mc license unregister`
- new `--encrypt-key` flag for `mc ilm restore`
- removed `--duration` flag for `mc support perf`
- new `--api-key` flag for `mc license register`
No doc issue for tracking this release.
Closes#715 for ilm restore flag
Preview:
<img width="992" alt="Screenshot 2023-01-25 at 20 03 00"
src="https://user-images.githubusercontent.com/13393018/214613411-28d2b9b9-2031-4d6a-8aac-3ddeea763199.png">
Limitations:
- Arrows are only present on the carousel and not in the Lightbox
preview. In the future, I'll investigate the options for including
arrows on the Light box. For this, we might need to replace the existing
Lightbox plugin with a modern one.
- Loop navigation is not available; instead, arrows will only be shown
when they correspond to the first and last slides.
Several updates for the MinIO Console docs related to
[v0.22.2](https://github.com/minio/console/releases/tag/v0.22.2) and
[v0.22.3](https://github.com/minio/console/releases/tag/v0.22.3).
Also takes the opportunity to break up the Console doc and remove
screenshots.
- Splits MinIO Console doc into three separate pages
- Removes screenshots from console pages
- Adds toctree to MinIO Console page and references to new pages
Closes#709
- Adds OIDC and LDAP sections to console
Closes#683
- Adds details on object browser (now separated out from bucket browser)
Closes#686
- updates Makefile to retrieve ARM URLs
- updates default-conf to create substitutes for ARM URLs
- updates linux install include to add dropdowns for each architecture
Closes#679
- Modifies decommissioning page to mention completing any planned
expansions first.
- Modifies expand deployment page to mention completing before doing any
planned decommssions.
- Minor grammar fixes to expand tenant page.
Closes#702
Two releases for MinIO in December 2022 and Jan 2023 affected the docs.
Updates for Dec 2022 minio updates
- Adds 500,000 as the recommended but not hard limit to number of
buckets
- Adds info on encrypting list of file names in zip archives
Closes#684
Updates for Jan 2 2023 release
- Adds info about setting server to listen on multiple IP addresses
- Updates list of available metrics
Closes#689
This PR applies updates to numerous files to address changes in the two
December 2022 `mc` releases.
- Deprecates `mc admin bucket quota` and links to new commands
- Adds `mc quota set | clear | info` commands
- Adds `attach | detach` subcommands to `mc admin idp ldap policy`
- Updates list of call types available to `mc admin trace`
- Updates `mc` page with new commands
- Fixes minor errors in `mc cp`
- Adds `--limit-*` flags to global flag options
- Adds `--versions` flag to `mc find`
Closes#685
- Updates ilm commands for new structure for tiers and rules
- Deprecates `mc admin tier`
- Deprecates `mc ilm add | edit | export | import | ls | rm` commands
- Adds new `mc ilm rule` and six subcommands
- Adds new `mc ilm tier` and six subcommands
- Updates references to ilm and admin tier commands throughout docs
- Adds new deprecated commands page
- Adds `mc ilm rule` and `mc ilm tier` holding pages with toctrees
- Closes#691
- Closes#662
Closes#677
Updates the site replication recovery tutorial with slight tweaks to the multi-site expansion tutorial to account for the latest changes to MinIO/MC
Co-authored-by: Poorna <poornas@users.noreply.github.com>
Per @klauspost we need to add info to the docs about MinIO's
recommendation to limit prefixes to no more than 10k objects.
This updates the glossary entry, object management doc, and admin
concepts to add that recommendation.
Closes#666
- Default Sphinx search page has been replaced with Algolia's
- Enabled routing to sync the search results with URL
**Preview:**
<img width="1458" alt="Screenshot 2022-12-30 at 14 47 28"
src="https://user-images.githubusercontent.com/13393018/210061993-c906461e-87e2-426f-b956-462cfa77ed40.png">
**How to test:**
1. Click on a search result, navigate back using the browser back button
and check whether the search result modal is open and available.
2. Type a search keyword and press the enter key to navigate to the
search results page, where you can find all the results listed.
Note: You might need to start the local web server on the exact build
sub-directory to test the point number 2.
`build/[branch]/[platform]/html/` - ✔️
`build/` - ❌
## Updates for `console` early Dec22 releases
- Updated the instructions for registering for SUBNET from an airgapped
Console environment
- Minor typo in IAM doc.
Closes#664
Two of the items in that issue did not actually impact the docs. One
item is just a screenshot update that will be addressed later.
## Updates for `minio` early Dec22 releases
- Adds info about `mc` installed with container images
- Adds new envvar for KES enclaves
Closes#665
- Updates `mc support inspect` to correct alias to target in command
syntax
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
