Skip to content

Commit 3e40f14

Browse files
authored
Update docs for sts auth (#2229)
#### Reference Issues/PRs <!--Example: Fixes #1234. See also #3456.--> https://man312219.monday.com/boards/7852509418/pulses/8615374613 #### What does this implement or fix? Update STS auth docs #### Any other comments? #### Checklist <details> <summary> Checklist for code changes... </summary> - [ ] Have you updated the relevant docstrings, documentation and copyright notice? - [ ] Is this contribution tested against [all ArcticDB's features](../docs/mkdocs/docs/technical/contributing.md)? - [ ] Do all exceptions introduced raise appropriate [error messages](https://docs.arcticdb.io/error_messages/)? - [ ] Are API changes highlighted in the PR description? - [ ] Is the PR labelled as enhancement or bug so it appears in autogenerated release notes? </details> <!-- Thanks for contributing a Pull Request to ArcticDB! Please ensure you have taken a look at: - ArcticDB's Code of Conduct: https://github.com/man-group/ArcticDB/blob/master/CODE_OF_CONDUCT.md - ArcticDB's Contribution Licensing: https://github.com/man-group/ArcticDB/blob/master/docs/mkdocs/docs/technical/contributing.md#contribution-licensing -->
1 parent b3b0273 commit 3e40f14

File tree

2 files changed

+17
-3
lines changed

2 files changed

+17
-3
lines changed

docs/mkdocs/docs/api/arctic_uri.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ Available options for S3:
2222
| access | S3 access key |
2323
| secret | S3 secret access key |
2424
| path_prefix | Path within S3 bucket to use for data storage |
25-
| aws_auth | AWS authentication method. If setting is `default` (or `true` for backward compatibility), authentication to endpoint will be computed via [AWS default credential provider chain](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/credproviders.html). If setting is `sts`, AWS Security Token Service (STS) will be the authentication method used. If no options are provided AWS authentication will not be used and you should specify access and secret in the URI. More info is provided below |
26-
| aws_profile | Only when `aws_auth` is set to be `sts`. AWS profile to be used with AWS Security Token Service (STS). More info is provided below |
25+
| aws_auth | AWS authentication method. If setting is `default` (or `true` for backward compatibility), authentication to endpoint will be computed via [AWS default credential provider chain](https://docs.aws.amazon.com/sdk-for-cpp/v1/developer-guide/credproviders.html). If setting is `sts`, AWS Security Token Service (STS) will be the authentication method used. If no options are provided AWS authentication will not be used and you should specify access and secret in the URI. More info about `sts` is provided [here](https://docs.arcticdb.io/latest/aws/#aws-security-token-service-sts-setup) |
26+
| aws_profile | Only when `aws_auth` is set to be `sts`. AWS profile to be used with AWS Security Token Service (STS). More info about `sts` is provided [here](https://docs.arcticdb.io/latest/aws/#aws-security-token-service-sts-setup) |
2727

2828
Note: When connecting to AWS, `region` can be automatically deduced from the endpoint if the given endpoint
2929
specifies the region and `region` is not set.

docs/mkdocs/docs/aws.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ s3.delete_object(Bucket=bucket, Key='_arctic_check/check.txt')
8383
```
8484
The check object written in that script should not interfere with normal ArcticDB operation on the bucket.
8585

86-
# AWS Security Token Service (STS) setup
86+
## AWS Security Token Service (STS) setup
8787

8888
STS allows users to assume specfic roles in order to gain temporary access to AWS resources. Please refer to [the offical website](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html) for more details.
8989
To use it with ArcticDB, please setup the credential in the AWS shared **config** file.
@@ -131,3 +131,17 @@ This error suggests problems with configuration file. Check Role Arn and base so
131131
arcticdb_ext.exceptions.StorageException: E_S3_RETRYABLE Retry-able error: S3Error#99 : Encountered network error when sending http request for object '_arctic_cfg/cref/'
132132
```
133133
A loss of network connectivity could trigger such an error. Note, that this error will appear after several attempts to re-establish the connection
134+
### Custom CA cert support
135+
136+
Due to a known [issue](https://github.com/aws/aws-sdk-cpp/issues/2920) in AWS C++ SDK, STS authentication users on below OS are required to turn off [S3Storage.VerifySSL](https://docs.arcticdb.io/latest/runtime_config/#s3storageverifyssl):
137+
* RHEL Distributions with custom CA cert
138+
* Other Linux distributions
139+
140+
The workaround is making symlink for the CA cert in use to `/etc/pki/tls/certs`.
141+
Below is the *example* of doing so for the default CA cert in Ubuntu:
142+
143+
```
144+
ln -s /usr/lib/ssl/cert.pem /etc/pki
145+
ln -s /usr/lib/ssl/certs /etc/pki/tls/certs
146+
ln -s /etc/ssl/certs/ca-certificates.crt /etc/pki/tls/certs/ca-bundle.crt
147+
```

0 commit comments

Comments
 (0)