1
0
mirror of https://github.com/minio/docs.git synced 2025-04-19 21:02:14 +03:00

38 Commits

Author SHA1 Message Date
Daryl White
b8a62baa90
Fixing links to videos missing a : (#1321)
Found a few more links for videos missing a `:` after the `http`.
This fixes those.
2024-09-17 10:05:24 -04:00
Rushan
5f5fc42530
Fix the recommended video URLs on the Object Locking page (#1320) 2024-09-17 10:01:34 -04:00
Ravind Kumar
af6811de3a
Update data-compression.rst
Fixing typo
2024-09-13 13:38:24 -04:00
Thomas L. Kula
d87eb665c9
COMPLIANCE functionally equiv to S3 COMPLIANCE mode (#1309)
This seems to be a copy error, based on my comparison of the COMPLIANCE
LOCK and S3's Compliance mode (vs S3's Governance mode).

---------

Co-authored-by: Andrea Longo <feorlen@users.noreply.github.com>
2024-08-28 16:54:40 -04:00
Daryl White
684217cdf9
Minor fixes for remote storage names (#1275)
Swapping `_` for `-` in remote class names for S3.
2024-07-22 08:22:58 -04:00
Daryl White
0c5dc28687
MinIO removed the version limit in a prior version (#1244)
This removes references to version limits and suggests using object
expiration rules to manage unneeded noncurrent versions.

There is no doc issue to track this.
2024-06-13 10:37:37 -04:00
Daryl White
fa8c73d584
Updates for server and mc releases on 2024-06-10 (#1243)
For mc RELEASE.2024-06-10T16-44-16Z

- Updates `mc admin info` to add the `--offline` flag

For MinIO Server RELEASE.2024-06-11T03-13-30Z

- Adds to note to object management page about avoiding the `:`
character on Windows
- Adds info that directory objects (0-byte, end in `/`) do not tier

These releases do not have doc repo issues to track them.
2024-06-11 16:32:40 -04:00
Daryl White
9374fb56e4
Aggregate information on deleting objects (#1218)
Creates a new object management page to aggregate information on
deleting objects.
Links to the page from other docs throughout.

Intentionally leaves most delete information where it is in existing
docs.
    
Closes #741
2024-05-17 16:28:45 -04:00
Ravind Kumar
775e99d47b
DOCS-1190: RELEASE.2024-04-18T19-09-19Z (#1215)
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.
2024-05-10 18:16:49 -04:00
Daryl White
96224468c4
Add concept pages for Scanner and Healing (#1192)
Adds concept pages for healing and the scanner.
Updates other related files for better context.
    
Adds ref links and other related updates.
    
Closes #1168
2024-04-25 14:27:25 -04:00
Daryl White
c29eb489f4
Updates for two mc releases (#1160)
Adds updates for mc RELEASE.2024-02-24T01-33-20Z
    
- New `mc put` command
- New `mc get` command
- New `--expire-all-object-versions` flag for the `mc ilm rule add`
command
- Adds info to the expiration of objects in versioned buckets on the
Object Lifecycle Management page
    
Closes #1140

Adds updates for mc release RELEASE.2024-01-28T16-23-14Z
    
- adds --skip-errors flag to mc mirror
- updates the mc admin service commands
    
Closes #1120
2024-03-18 13:08:59 -04:00
Justin Griffin
ba3b7769ee
Doc update for supporting --endpoint arg with Azure remote tier (#1146)
This is the documentation update associated with PR
https://github.com/minio/minio/pull/19188 that adds the support for
expressing the `--endpoint` arg for a custom Azure blog storage backend.
This is useful for targeting Azure Gov Cloud, which has a different URL.

See https://github.com/minio/minio/pull/19188
2024-03-08 11:18:10 -05:00
Daryl White
47c09b7d31
Change instances of --JSON flag to --json (#1149)
Continues the work of #1148 to change all other instances of `--JSON` to
`--json`.
2024-03-06 08:59:17 -05:00
Andrea Longo
08eb7770dc
Small docs fixes and cleanups (#1138)
Many small fixes:
- Clarify that `mc legalhold set --recursive` applies to current objects
only. Go back and do it again if you want it to apply to newly created
objects.
- Clean up inconsistent capitalization of "legal hold."
- Fix a bunch more `:required:` and `:optional:`
- Add a resync step to the restore site replication instructions

Staged:

http://192.241.195.202:9000/staging/small-clarifications/linux/index.html
2024-02-23 11:37:53 -07:00
Ravind Kumar
535c1ed36b
DOCS-998: Tiering requires source and remote (#1008)
Closes #998
2023-09-21 11:44:38 -04:00
Daryl White
01606fbfa1
Updates for MinIO Server release 2023-08-04 (#1000)
Updates for release 2023-08-04T17-40-21Z
    
- Adds info on new 10,000 version limit to appropriate pags
- Updates Grafana with site replication info

Closes #938
2023-09-16 20:35:13 -04:00
Daryl White
e7e83d91b4
Documents the scanner.speed config and minio_scanner_speed envvar (#973)
Closes #796

And a few other paragraphs here there and yon.
2023-08-29 10:49:10 -05:00
Daryl White
20644952de
Grafana and metric updates (#953)
- Adds a new page for Grafana to overview.
- Replaces the list of metrics in the Metrics and Alerts page with an
include to pull the list of metrics maintained in GitHub.
- Removes use of the :metric: role throughout the docs.
- Adds note about the introduction of a new bucket metric endpoint.

Partially addresses #930
Partially addresses #931
Partially addresses #898
Closes #864

Staged:
-
http://192.241.195.202:9000/staging/grafana/operations/monitoring/grafana.html
-
http://192.241.195.202:9000/staging/grafana/operations/monitoring/grafana.html
2023-08-17 09:01:46 -05:00
Andrea Longo
2abd324c3a
split mc version into subcommand pages (#923)
Addresses potential confusion about required/optional and the several
mutually exclusive options.

Staged:

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version.html

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version-enable.html

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version-info.html

http://192.241.195.202:9000/staging/DOCS-918/linux/html/reference/minio-mc/mc-version-suspend.html

Fixes https://github.com/minio/docs/issues/918

---------

Co-authored-by: Ravind Kumar <ravind@min.io>
2023-07-20 10:04:58 -06:00
Andrea Longo
bb1600952e
Data compression docs (#915)
Document data compression, including security concerns with encrypting
compressed objects.

Staged:

http://192.241.195.202:9000/staging/DOCS-830/linux/html/administration/object-management/data-compression.html

http://192.241.195.202:9000/staging/DOCS-830/linux/html/reference/minio-mc-admin/mc-admin-config.html#data-compression

http://192.241.195.202:9000/staging/DOCS-830/linux/html/reference/minio-server/minio-server.html#data-compression

---------

Co-authored-by: Klaus Post <klauspost@gmail.com>
2023-07-17 12:33:15 -06:00
Ravind Kumar
7a01ca72e6
DOCS-888: prefix exclusion of versioning prevents replication (#893)
Closes #888 

# Summary

- MinIO requires versioning for replication
- We support excluding prefixes/folders in buckets selectively
- This prevents replication within those prefixes/folders

Also included in this ticket

- Added an image to the site replication page
- Fixed a broken SVG
- Minor tweaking of site replication page.

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-06-23 13:19:45 -04:00
Ravind Kumar
40448a5617
minor improvement to versioned delete ops (#880)
Minor change to improve discussion around versioned delete operations
and cleanup

---------

Co-authored-by: Daryl White <53910321+djwfyi@users.noreply.github.com>
2023-06-14 15:50:02 -04:00
Ravind Kumar
79e55b4d90
DOCS-845: Updates for MinIO Server RELEASE.2023-05-04T21-44-30Z (#852)
Closes #845 

Staged: http://192.241.195.202:9000/staging/DOCS-845/linux/index.html
2023-05-17 17:38:27 -04:00
Ravind Kumar
a432637298
Adding more EDU videos (#803) 2023-04-10 16:36:35 -04:00
Daryl White
199d1eb1d4
Adds info on certificates with the MinIO Client (#782)
- Adds a new section on certificates to the MinIO Client page
- Adds a new section in Behaviors to the mc alias set page
- Minor fix to a --json flag command in version doc

Closes #781
2023-03-30 13:04:10 -05:00
Andrea Longo
31d5fbd117
Exclude prefixes or folders from versioning (#769)
Object versioning can now be configured with certain exclusions (no
longer strictly on a per-bucket basis). Add documentation about how to
use the new options:
* `--excluded-prefixes` to exclude objects with certain prefixes
* `--exclude-folders` to exclude anything with name ending in `/`
(folders)

- [x] Exclude prefixes
- [x] Exclude folders
- [x] Wildcards/globbing
- [x] Limitations
- [x] View versioning exclusion configuration

Staged:
[Bucket
Versioning](http://192.241.195.202:9000/staging/DOCS-760/linux/html/administration/object-management/object-versioning.html)
[mc
version](http://192.241.195.202:9000/staging/DOCS-760/linux/html/reference/minio-mc/mc-version.html)

Fixes https://github.com/minio/docs/issues/760

---------

Co-authored-by: Krishnan Parthasarathi <krisis@users.noreply.github.com>
2023-03-28 16:51:11 -06:00
Daryl White
6482571bf2
Update mc reference docs for improved nav structure (#717)
- 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
2023-02-02 16:52:36 -06:00
Ravind Kumar
3559267dea
DOCS-699: improve documentation on storage classes for remote targets (#700)
Closes #699
2023-01-12 15:14:13 -05:00
Ravind Kumar
9ae1e87c75 Fixing issues after multiple large merges 2023-01-10 17:44:40 -05:00
Daryl White
00de8dbeb6
Updates to mc docs for December 2022 releases (#697)
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
2023-01-10 15:47:02 -06:00
Ravind Kumar
c2dacd93f2
DOCS-691: Fix replication tutorials for new syntax, other minor fixes (#693)
Partially addresses #691 

Follows up #692 

#. Summary

Updates replication tutorials to use latest syntax for `mc replicate
add`, removing references to `mc admin bucket remote add`

Includes some build output fixes for non-Linux builds.

Staged:

- [One-Way Bucket
Replication](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/enable-server-side-one-way-bucket-replication.html#configure-one-way-bucket-replication-using-the-command-line-mc)
- [Two-Way Bucket
Replication](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/enable-server-side-two-way-bucket-replication.html#configure-two-way-bucket-replication-using-the-command-line-mc)
- [Three-Way Bucket
Replication](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/enable-server-side-multi-site-bucket-replication.html#configure-multi-site-bucket-replication-using-the-command-line-mc)
- [Resynchronize
Bucket](http://192.241.195.202:9000/staging/DOCS-691-partial/linux/administration/bucket-replication/server-side-replication-resynchronize-remote.html)
2023-01-04 21:49:26 -05:00
Ravind Kumar
1cfda2e9dc
RELEASE: Multiple Issues (#647)
Closes #639 
Closes #635 
Partially Addresses #590 

- MINIO #16026 https://github.com/minio/minio/pull/16026
- MINIO #16044 https://github.com/minio/minio/pull/16044
- MINIO #16035 https://github.com/minio/minio/pull/16035
- CONSOLE #2428 https://github.com/minio/console/pull/2428

Other Fixes:

- Removes admonition about IDP interactions (multi-IDP support)
- Update Console screenshots and overview page to cover layout changes
- Partial fix for DOCS #590 (Policy now under Identity section)
2022-11-23 14:51:47 -05:00
Daryl White
bce5f8267f
Updates for minio RELEASE.2022-08-22T23-53-06Z (#648)
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
2022-11-22 15:08:35 -06:00
Daryl White
0cd491c328
Mc updates for multiple releases (#642)
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 #571
Closes #614
Closes #627
Closes #633
2022-11-18 12:49:03 -06:00
Ravind Kumar
82c6d38278 Minor fixes 2022-10-20 17:57:16 -04:00
Ravind Kumar
d815aa9ce8
Final pass on platformization (#555) 2022-09-16 16:40:20 -04:00
Krishnan Parthasarathi
42bb882c8b
Fix typo in tier add example (#558) 2022-09-13 15:24:56 -04:00
Ravind Kumar
b99c20a16f Docs Multiplatform Slice 2022-06-14 17:01:18 -04:00