minio/docs
1
0
Fork 0
mirror of https://github.com/minio/docs.git synced 2025-07-30 07:03:26 +03:00
Code Activity

DOCS-IA: Platformize SSE Docs. Hashicorp Pass (#518)

Browse Source 
* Platformization of Data Encryption Docs: Hashicorp Pass

* Platformization of Data Encryption Docs: Hashicorp Pass

* Big pass, CR changes + K8s
This commit is contained in:
Ravind Kumar
2022-08-15 12:53:08 -04:00
committed by GitHub
parent 0e63416cb1
commit 2376fa9924
41 changed files with 1837 additions and 310 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
source/developers/haskell/API.md
View File

@ -385,7 +385,7 @@ __Parameters__
| Param | Type | Description |
|--------------|----------|---------------------------------------------------------------------------------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `prefix` | _string_ | Prefix of the object names that are partially uploaded. (optional, default `''`) |
| `recursive` | _bool_ | `true` indicates recursive style listing and `false` indicates directory style listing delimited by '/'. (optional, default `false`). |
@ -427,7 +427,7 @@ __Parameters__
| Param | Type | Description |
|----------------------|------------|----------------------------------------------------------------------------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, res)` | _function_ | Callback is called with `err` in case of error. `res` is the response object. If no callback is passed, a `Promise` is returned. |
__Example__
@ -451,7 +451,7 @@ __Parameters__
| Param | Type | Description |
|--------------------|------------|----------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `versioningConfig` | _object_ | Versioning Configuration e.g: `{Status:"Enabled"}` |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
@ -477,7 +477,7 @@ __Parameters__
| Param | Type | Description |
|---------------------|------------|--------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `replicationConfig` | _object_ | replicationConfig Configuration as a JSON Object |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
@ -522,7 +522,7 @@ __Parameters__
| Param | Type | Description |
|------------------------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, replicationConfig)` | _function_ | Callback is called with `err` in case of error. else returns the info in`replicationConfig` ,which contains`{role: __string__, rules:__Array__ }`. |
__Example__
@ -545,7 +545,7 @@ __Parameters__
| Param | Type | Description |
|-----------------|------------|-------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
__Example__
@ -568,7 +568,7 @@ __Parameters__
| Param | Type | Description |
|-----------------|------------|-----------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `tags` | _object_ | Tags map Configuration e.g: `{<tag-key-1>:<tag-value-1>}` |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
@ -591,7 +591,7 @@ __Parameters__
| Param | Type | Description |
|-----------------|------------|-------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
__Example__
@ -613,7 +613,7 @@ __Parameters__
| Param | Type | Description |
|---------------------------|------------|-------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, tagsList)` | _function_ | Callback is called with `err` in case of error. |
__Example__
@ -636,7 +636,7 @@ __Parameters__
| Param | Type | Description |
|-------------------|------------|------------------------------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `lifecycleConfig` | _object_ | Valid Lifecycle Configuration or ( `null` or `''` ) to remove policy configuration |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
@ -675,7 +675,7 @@ __Parameters__
| Param | Type | Description |
|------------------------------------|------------|---------------------------------------------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(error, lifecycleConfig)` | _function_ | Callback is called with `lifecycleConfig` in case of success. Otherwise it is called with `error` |
__Example__
@ -697,7 +697,7 @@ __Parameters__
| Param | Type | Description |
|-----------------|------------|-------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
__Example__
@ -722,7 +722,7 @@ __Parameters__
| Param | Type | Description |
|-----------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `lockConfig` | _object_ | Lock Configuration can be either `{}` to reset or object with all of the following key/value pairs: `{mode: ["COMPLIANCE"/'GOVERNANCE'], unit: ["Days"/"Years"], validity: <a-valid-number-for-unit>}` |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
@ -760,7 +760,7 @@ __Parameters__
| Param | Type | Description |
|-----------------------------|------------|-------------------------------------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, lockConfig)` | _function_ | Callback is called with `err` in case of error. else it is called with lock configuration |
__Example __
@ -785,7 +785,7 @@ __Parameters__
| Param | Type | Description |
|--------------------|------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `encryptionConfig` | _object_ | Encryption Configuration can be either omitted or `{}` or a valid and supported encryption config. by default: `{Rule:[{ApplyServerSideEncryptionByDefault:{SSEAlgorithm:"AES256"}}]}` is applied. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
@ -823,7 +823,7 @@ __Parameters__
| Param | Type | Description |
|----------------------------|------------|-------------------------------------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err, encConfig)` | _function_ | Callback is called with `err` in case of error. else it is called with lock configuration |
__Example __
@ -848,7 +848,7 @@ __Parameters__
| Param | Type | Description |
|-----------------|------------|-------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
__Example __
@ -1473,7 +1473,7 @@ __Parameters__
| Param | Type | Description |
|-----------------|------------|---------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `tags` | _object_ | Tags map Configuration e.g: `{<tag-key-1>:<tag-value-1>}` |
| `putOpts` | _object_ | Default is {}. e.g `{versionId:"my-version-id"}`. (Optional) |
@ -1510,7 +1510,7 @@ __Parameters__
| Param | Type | Description |
|-----------------|------------|---------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `removeOpts` | _object_ | Defaults to {}. e.g `{versionId:"my-version-id"}`. (Optional) |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
@ -1547,7 +1547,7 @@ __Parameters__
| Param | Type | Description |
|-----------------|------------|---------------------------------------------------------------|
| `bucketname` | _string_ | Name of the bucket. |
| `bucketName` | _string_ | Name of the bucket. |
| `objectName` | _string_ | Name of the object. |
| `getOpts` | _object_ | Defaults to {}. e.g `{versionId:"my-version-id"}`. (Optional) |
| `callback(err)` | _function_ | Callback is called with `err` in case of error. |
@ -1912,8 +1912,16 @@ policy.setExpires(expires)
// Only allow 'text'.
policy.setContentType('text/plain')
// Set content disposition response header.
policy.setContentDisposition('attachment; filename=text.txt')
// Only allow content size in range 1KB to 1MB.
policy.setContentLengthRange(1024, 1024*1024)
// Set key-value user defined metadata
policy.setUserMetaData({
key: 'value'
})
```
POST your content from the browser using `superagent`: