##
We are going to make the following changes to the Object Store docs as
part of a larger QC/Content pass:
### Left Navigation
We want to modify the left navigation flow to be a natural progression
from a basic setup to more advanced.
For example:
- Core Concepts
- Deployment Architecture
- Availability and Resiliency
- Erasure Coding and Object Healing
- Object Scanner
- Site Replication and Failover
- Thresholds and Limits
- Installation
- Deployment Checklist
- Deploy MinIO on Kubernetes
- Deploy MinIO on Red Hat Linux
- Deploy MinIO on Ubuntu Linux
- Deploy MinIO for Development (MacOS, Windows, Container)
- Security and Encryption (Conceptual Overview)
- Network Encryption (TLS) (Conceptual overview)
- Enable Network Encryption using Single Domain
- Enable Network Encryption using Multiple Domains
- Enable Network Encryption using certmanager (Kubernetes only)
- Data Encryption (SSE) (Conceptual overview)
- Enable SSE using AIStor Key Management Server
- Enable SSE using KES (Summary page + linkouts)
- External Identity Management (Conceptual Overview)
- Enable External Identity management using OpenID
- Enable External Identity management using AD/LDAP
- Backup and Recovery
- Create a Multi-Site Replication Configuration
- Recovery after Hardware Failure
- Recover after drive failure
- Recover after node failure
- Recover after site failure
- Monitoring and Alerts
- Metrics and Alerting (v3 reference)
- Monitoring and Alerting using Prometheus
- Monitoring and Alerting using InfluxDB
- Monitoring and Alerting using Grafana
- Metrics V2 Reference
- Publish Server and Audit Logs to External Services
- MinIO Healthcheck API
The Administration, Developer, and Reference sections will remain as-is
for now.
http://192.241.195.202:9000/staging/singleplat/mindocs/index.html
# Goals
Maintaining multiple platforms is getting to be too much, and based on
analytics the actual number of users taking advantage of it is minimal.
Furthermore, the majority of traffic is to installation pages.
Therefore we're going to try to collapse back into a single MinIO Object
Storage product, and use simple navigation and on-page selectors to
handle Baremetal vs Kubernetes.
This may also help to eventually stage us to migrate to Hugo + Markdown
---------
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
Co-authored-by: Rushan <rushenn@minio.io>
Co-authored-by: rushenn <rushenn123@gmail.com>
Include files for quickstarts had a page title that resulted in a
duplicate H1. This removes the duplicate and moves the links for video
to the index.rst page.
Opportunity fix of an unrelated build error.
Closes#1408
- Adds missing config settings throughout storage class page.
Closes#1349
- Adds instructions for adding certificates for connecting by sftp.
Closes#1354
- Corrects information about which key to use for self-signed CAs.
Closes#1358
- Moves `context` to optional for batch key rotate jobs.
Closes#1356
- clean up missing ref links causing build warnings.
- Adds info the docs about recent changes to LDAP and SFTP
authentication
- Adds new config/envvar parameter
- Adds new sftp option for server
- Adds new example for forcing ldap or sa auth to SFTP
- Adds new example for using certificate authority for auth to SFTP
Closes#1240Closes#1229Closes#1226Closes#1208
Partially addresses #1190
No staged build unless someone requests it.
# Summary
After some thinking, we've leaned towards just making a note of the
upgrade step and calling it done. We do not typically make extended
discussion of backward-breaking changes at this time, and have no where
to keep that sort of guidance.
Maybe in the future or as part of a larger re-arch we can consider where
we would best keep that kind of guidance.
As far as the rest:
- We are not covering s3zip today, so that's a no-op. We should leave
the ticket open in the event we have bandwidth to document the feature
later
- No changes to Console that need documentation at this time
- Added a quick callout on the warning behavior to the Versioning page
- Metrics v3 is also still In progress, come back to this once the
project is fully baked.
No related issue here, just freewheeling from an internal request.
This started with the request to change our recommendation around
label/uuid-based drive mounting to a requirement.
Looking at the pages I feel like our pre-req and considerations are a
little long in the tooth, and are at least slightly duplicative of what
is on the checklist pages (hardware, software)
This is at least a first swing at tidying things up. I think in a second
pass I'll move more of the pre-reqs into the Hardware/Software/Security
checklist pages, and keep the on-tutorial sections as simple defnlists
so that the page flows more easily. We can push users to the details if
they want it while keeping the high level requirements there.
Noting this does **not** yet address the new features related to
non-sequential hostname support. That has to come later.
---------
Co-authored-by: Eco <41090896+eco-minio@users.noreply.github.com>
Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
DOCS-902: Add "M' and "Mi" units to --limit-upload and --limit-download
DOCS-895: Take Bucket/IAM snapshot before site replication config
DOCS-886: Add audit_kafka config settings and envvars.
- 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
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
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
@djwfyi cursory review in case I missed something.
Closes#580
I do need to do further testing beyond the patches here. But I'm going
to handle that out-of-band.
This commit also generally cleans up the Installation docs and uses /includes/<platform>/steps-*.rst as a pattern for storing platform-specific tutorials within a single root URL.
Finally, due to API rate limits, this commit adds some Makefile magic to allow skipping of sync'ing dependencies. Pass `make BUILD_DEPENDENCIES=FALSE <platform>` to skip building any deps and use what is already in the branch.
