Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: replaced dead s3 docs url and added attributes table #163

Merged
merged 1 commit into from
Mar 25, 2024
Merged

docs: replaced dead s3 docs url and added attributes table #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 55 additions & 36 deletions .wordlist.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
accesskey
ACL
allocs
alongside
amd
apache
api
API
APIs
api
apikey
APIKeyPayload
APIs
artifacthub
artifactType
ASLR
Expand All @@ -29,9 +31,10 @@ CD
certDir
checksum
checksums
chunksize
CI
cli
CLI
cli
ClusterIP
cmdline
CNAME
Expand All @@ -42,16 +45,16 @@ config
ConfigMap
conformant
containerd
CPUs
cpu
CPUs
credentialsFile
cri
CRI
cri
crt
CSS
cURL
cve
CVE
cve
CVEListForImage
CVEs
darwin
Expand All @@ -72,24 +75,25 @@ Dockerfile
dropdown
dryRun
ExpandedRepoInfo
ExtensionList
ExpandedRepoInfo
ExtensionList
ExternalName
Filebeat
filesystem
filesystems
freebsd
forcepathstyle
FreeBSD
freebsd
fullname
Fullstack
gc
gcInterval
gcr
ghcr
github
GitHub
gitlab
github
GitLab
gitlab
GlobalSearch
golang
golang's
Expand All @@ -102,59 +106,67 @@ gui
haproxy
hostname
href
htpasswd
html
htpasswd
http
https
ImageList
ImageListForDigest
ImagesListForCVE
ImagesListWithCVEFixed
IAM
ImageIndex
ImageList
ImageList
ImageListForDigest
ImageListForDigest
ImageManifest
ImagesListForCVE
ImagesListForCVE
ImagesListWithCVEFixed
ImageManifest
ImagesListWithCVEFixed
ImageTags
ImageTrust
inlinehilite
in-place
inlinehilite
io
IoT
JSON
json
keepTags
KEP
keyid
KMS
kubeconfig
kubectl
kubelet
kubernetes
Kubernetes
ldap
kubernetes
LDAP
ldap
licensable
LICENSE
Licensor
lifecycle
linter
linux
linuxfoundation
loadbalancer
LoadBalancer
loadbalancing
loadbalancer
Loadbalancing
loadbalancing
localhost
loglevel
MacOS
maxRetries
md
MERCHANTABILITY
mgmt
minify
Minio
mkdocs
mostRecentlyPulledCount
mostRecentlyPushedCount
mTLS
multipartcopychunksize
multipartcopymaxconcurrency
multipartcopythresholdsize
mutex
mutexes
myfile
Expand All @@ -163,20 +175,21 @@ ng
nginx
NodePort
OAuth
oci
objectacl
OCI
oci
OIDC
oidc
ok
onboarding
Onboarding
onboarding
onDemand
onlySigned
openjdk
OpenAPI
OpenID
oras
openjdk
ORA
oras
OSSF
permalink
PKI
Expand All @@ -186,8 +199,8 @@ podman
pollInterval
pprof
PR
PRs
prometheus
PRs
pulledWithin
pullPolicy
pushedWithin
Expand All @@ -196,6 +209,7 @@ rc
README
regclient
regctl
regionendpoint
replicaCount
repo
RepoListWithNewestImage
Expand All @@ -205,28 +219,32 @@ RepositoryList
requestor
retryDelay
roadmap
rootdirectory
runc
runtime
runtimes
satisfiable
Satisfiable
satisfiable
SBOM
SBOMs
SDK
secretkey
semver
serviceAccount
SHA
SLI
skipverify
skopeo
SLI
SRE
SSL
stacker
storageclass
StrippedConfig
stripPrefix
stylesheets
subcommand
subcommands
subcommand's
subcommands
subdirectory
sublicense
subpath
Expand All @@ -244,32 +262,34 @@ toggleStar
toolchain
tooltips
transactional
trivy
Trivy
truststore
truststores
trivy
trustStore
truststore
trustStores
truststores
truststoreType
tunable
twemoji
UI
unrecovered
unreviewed
untagged
uri
URI
uri
URL
url
urls
URL
usedualstack
useragent
userprefs
usr
UUID
VM
VMs
www
yaml
YAML
yaml
zb
zli
zot
Expand All @@ -278,4 +298,3 @@ zothub
zotregistry
zui
zxp

31 changes: 29 additions & 2 deletions docs/articles/storage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,8 +243,35 @@ To configure an Amazon Simple Storage Service (s3) bucket for zot, use the `stor
}
```

For descriptions of the configurable attributes for `storageDriver`, see the [s3 storage driver](https://github.com/docker/docker.github.io/blob/master/registry/storage-drivers/s3.md) project in GitHub.

The following table lists the attributes of `storageDriver` when configuring s3 for remote storage:

tk-nguyen marked this conversation as resolved.
Show resolved Hide resolved
| Attribute | Required | Description |
|-----------------------------|----------|------------------------------------------------------------------------------------------------------------------------------------|
| name | yes | Name of storage driver. Only `s3` is supported for now. |
| accesskey | no | Your AWS Access Key. If you use IAM roles, omit to fetch temporary credentials from IAM. |
| secretkey | no | Your AWS Secret Key. If you use IAM roles, omit to fetch temporary credentials from IAM. |
| region | yes | The AWS region in which your bucket exists. |
| regionendpoint | no | Endpoint for S3 compatible storage services (Minio, etc). |
| forcepathstyle | no | To enable path-style addressing when the value is set to true. The default is true. |
| bucket | yes | The bucket name in which you want to store the registry’s data. |
| encrypt | no | Specifies whether the registry stores the image in encrypted format or not. A boolean value. The default is false. |
| keyid | no | Optional KMS key ID to use for encryption (encrypt must be true, or this parameter is ignored). The default is none. |
| secure | no | Indicates whether to use HTTPS instead of HTTP. A boolean value. The default is true. |
| skipverify | no | Skips TLS verification when the value is set to true. The default is false. |
| v4auth | no | Indicates whether the registry uses Version 4 of AWS’s authentication. The default is true. |
| chunksize | no | The S3 API requires multipart upload chunks to be at least 5MB. This value should be a number that is larger than 5 * 1024 * 1024. |
| multipartcopychunksize | no | Default chunk size for all but the last S3 Multipart Upload part when copying stored objects. |
| multipartcopymaxconcurrency | no | Max number of concurrent S3 Multipart Upload operations when copying stored objects. |
| multipartcopythresholdsize | no | Default object size above which S3 Multipart Upload will be used when copying stored objects. |
| rootdirectory | no | This is a prefix that is applied to all S3 keys to allow you to segment data in your bucket if necessary. |
| storageclass | no | The S3 storage class applied to each registry file. The default is STANDARD. |
| useragent | no | The User-Agent header value for S3 API operations. |
| usedualstack | no | Use AWS dual-stack API endpoints. |
| accelerate | no | Enable S3 Transfer Acceleration. |
| objectacl | no | The S3 Canned ACL for objects. The default value is “private”. |
| loglevel | no | The log level for the S3 client. The default value is off. |

For more information, see the [s3 storage driver docs](https://distribution.github.io/distribution/storage-drivers/s3/).

### s3 Credentials

Expand Down
Loading