##
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>
- Adds that `idmp-` string is added to `ROLE_ID` when generating an ARN
- Updates claims example in the plugin docs to be JSON instead of basic
comma-delimited key-value pairs
New SDK page for the Rust SDK, with a quickstart from
`minio/minio-rs/README.md`
Going with an external link to a generated reference. Will deal with
API.md as we can.
~We may yet get an `API.md`, so this PR is a draft for now.~
The JavaScript Install instructions include a TypeScript section. I
removed it entirely because types are now provided by `minio-js` and
should not be installed separately via `@types/minio`.
Happy to consider alternatives, such as keeping the section with a note
like "types are now provided by the `minio-js` package".
Adds section to the policy based access control page for supported KMS
action keys.
Refers two existing kms related keys to the preferred `kms:` keys.
Closes#1283
- removes `--logs` flag from `mc support callhome`
- enforces 100 bucket limit for v2 metrics
Closes#1439
Opportunistic fix to remove errant copy/paste for
`--noncurrent-expire-days` flag in `mc ilm rule add`
Closes#1438
This commit removes lengthy discussion of SUBNET from the community
docs. Other affected pages that linked to removed sections also updated.
Also reduces references to Call Home to the remaining mc support pages
and links to those pages.
Hidden env var `_MINIO_BATCH_REPLICATION_WORKERS` is being referred to
in documentation. It needs to be either:
- removed as a hidden variable
- renamed with a leading `_`
- enabled as a regular variable in ~`minio`~ and `eos`, without a
leading `_`
See example the files referred to in the PR and
39df134204/cmd/batch-handlers.go (L398)
Pending review and discussion with @harshavardhana and @poornas
This PR removes documentation references to this variable.
Only applicable for remote tiers that are also MinIO deployments.
Per internal discussion.
Need to verify if this applies to the `edit` command and the
`noncurrent-transition-days` flags.
MinIO uses RFC3339 data and time formatting and not ISO-8601. RFC3339
requires that there be a `T` as part of the data and time separation.
ISO-8601 allows a space.
The documentation also currently refers to using a date in the batch
framework; this should be a RFC3339 date and time.
e.g.
```
mc batch start play expire.yaml
mc: <ERROR> Unable to start job. We encountered an internal error, please try again.: cause(parsing time "2006-01-02 15:04:05.00Z" as "2006-01-02T15:04:05Z07:00": cannot parse " 15:04:05.00Z" as "T").
```
---------
Co-authored-by: Ravind Kumar <ravindk89@gmail.com>
#### Issue
Batch replication requires specific actions to be performable by the
source user, including:
```
"admin:ListBatchJobs",
"admin:DescribeBatchJob",
"admin:StartBatchJob",
"admin:CancelBatchJob"
```
This PR suggests them in the batch replication example provided in the
docs.
@poornas Please correct me if needed. This allowed the documentation to
be followed smoothly, with a resultant successful batch replication job
being spawned.
The page with the event type detail seemed an ok place to put this.
Suggestions for other/additional locations welcome.
Tested on AIStor + EOS with an outbound webhook to an external service.
Since I had a live example, I included it in the page as well.
Fixes https://github.com/minio/docs/issues/1394
# Summary
We removed support for deploying via OpenShift operatorhub / marketplace
a few months back. The burden of maintaining the certifications/process
required was sufficient to pull that feature set out moving forward and
migrate it to AIStor as part of a more complete enterprise offering.
For now we need to remove references to the operator hub / marketplace.
It is possible that the Openshift Kubernetes Engine may work w/ our
stock kubernetes installation paths, but we do not have resources to
test.
So for the immediate term, we're just going to pull whats outdated.
Also throwing in a fixup to the CRDs - I ran into a weird issue where I
had to `pip3 install asciidoc` before the sync-operator-crd-docs job
worked, am looking into that separately.
Staged:
http://192.241.195.202:9000/staging/openshift-fixup/openshift/index.html
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
Fixes#1404
Two sets of fixes:
- add conditionals for windows and linux where shared
- search/replace for linux only (MinIO Server reference pages)
Staging server not available, tested/checked locally
