Adds object storage client for Swift OpenStack (#2440)

* Implement swift storage client.

Signed-off-by: Cyril Tovena <[email protected]>
Signed-off-by: Marco Pracucci <[email protected]>

* Pass nil registrerer.

Signed-off-by: Peter Štibraný <[email protected]>

* Make lint happy.

Signed-off-by: Peter Štibraný <[email protected]>

Co-authored-by: Peter Štibraný <[email protected]>

Author: cyriltovena

.circleci/config.yml

@@ -155,6 +155,7 @@ jobs:
           docker pull shopify/bigtable-emulator:0.1.0
           docker pull rinscy/cassandra:3.11.0
           docker pull memcached:1.6.1
+          docker pull bouncestorage/swift-aio:55ba4331
     - run:
         name: Integration Tests
         command: |

CHANGELOG.md

@@ -22,6 +22,7 @@
 * [CHANGE] Slow query log has a different output now. Previously used `url` field has been replaced with `host` and `path`, and query parameters are logged as individual log fields with `qs_` prefix. #2520
 * [CHANGE] Experimental WAL: WAL and checkpoint compression is now disabled. #2436
 * [FEATURE] Ruler: The `-ruler.evaluation-delay` flag was added to allow users to configure a default evaluation delay for all rules in cortex. The default value is 0 which is the current behavior. #2423
+* [FEATURE] Experimental: Added a new object storage client for OpenStack Swift. #2440
 * [ENHANCEMENT] Experimental TSDB: sample ingestion errors are now reported via existing `cortex_discarded_samples_total` metric. #2370
 * [ENHANCEMENT] Failures on samples at distributors and ingesters return the first validation error as opposed to the last. #2383
 * [ENHANCEMENT] Experimental TSDB: Added `cortex_querier_blocks_meta_synced`, which reflects current state of synced blocks over all tenants. #2392

docs/architecture.md

@@ -62,6 +62,7 @@ The blocks storage doesn't require a dedicated storage backend for the index. Th
 * [Google Cloud Storage](https://cloud.google.com/storage/)
 * [Microsoft Azure Storage](https://azure.microsoft.com/en-us/services/storage/)
 * [Local Filesystem](https://thanos.io/storage.md/#filesystem) (single node only)
+* [OpenStack Swift](https://wiki.openstack.org/wiki/Swift) (experimental)
 
 For more information, please check out the [Blocks storage](operations/blocks-storage.md) documentation.
 

docs/configuration/config-file-reference.md

@@ -819,6 +819,66 @@ storage:
     # CLI flag: -ruler.storage.s3.force-path-style
     [s3forcepathstyle: <boolean> | default = false]
 
+  swift:
+    # Openstack authentication URL.
+    # CLI flag: -ruler.storage.swift.auth-url
+    [auth_url: <string> | default = ""]
+
+    # Openstack username for the api.
+    # CLI flag: -ruler.storage.swift.username
+    [username: <string> | default = ""]
+
+    # Openstack user's domain name.
+    # CLI flag: -ruler.storage.swift.user-domain-name
+    [user_domain_name: <string> | default = ""]
+
+    # Openstack user's domain id.
+    # CLI flag: -ruler.storage.swift.user-domain-id
+    [user_domain_id: <string> | default = ""]
+
+    # Openstack userid for the api.
+    # CLI flag: -ruler.storage.swift.user-id
+    [user_id: <string> | default = ""]
+
+    # Openstack api key.
+    # CLI flag: -ruler.storage.swift.password
+    [password: <string> | default = ""]
+
+    # Openstack user's domain id.
+    # CLI flag: -ruler.storage.swift.domain-id
+    [domain_id: <string> | default = ""]
+
+    # Openstack user's domain name.
+    # CLI flag: -ruler.storage.swift.domain-name
+    [domain_name: <string> | default = ""]
+
+    # Openstack project id (v2,v3 auth only).
+    # CLI flag: -ruler.storage.swift.project-id
+    [project_id: <string> | default = ""]
+
+    # Openstack project name (v2,v3 auth only).
+    # CLI flag: -ruler.storage.swift.project-name
+    [project_name: <string> | default = ""]
+
+    # Id of the project's domain (v3 auth only), only needed if it differs the
+    # from user domain.
+    # CLI flag: -ruler.storage.swift.project-domain-id
+    [project_domain_id: <string> | default = ""]
+
+    # Name of the project's domain (v3 auth only), only needed if it differs
+    # from the user domain.
+    # CLI flag: -ruler.storage.swift.project-domain-name
+    [project_domain_name: <string> | default = ""]
+
+    # Openstack Region to use eg LON, ORD - default is use first region (v2,v3
+    # auth only)
+    # CLI flag: -ruler.storage.swift.region-name
+    [region_name: <string> | default = ""]
+
+    # Name of the Swift container to put chunks in.
+    # CLI flag: -ruler.storage.swift.container-name
+    [container_name: <string> | default = "cortex"]
+
 # file path to store temporary rule files for the prometheus rule managers
 # CLI flag: -ruler.rule-path
 [rule_path: <string> | default = "/rules"]
@@ -1601,6 +1661,66 @@ filesystem:
   # CLI flag: -local.chunk-directory
   [directory: <string> | default = ""]
 
+swift:
+  # Openstack authentication URL.
+  # CLI flag: -swift.auth-url
+  [auth_url: <string> | default = ""]
+
+  # Openstack username for the api.
+  # CLI flag: -swift.username
+  [username: <string> | default = ""]
+
+  # Openstack user's domain name.
+  # CLI flag: -swift.user-domain-name
+  [user_domain_name: <string> | default = ""]
+
+  # Openstack user's domain id.
+  # CLI flag: -swift.user-domain-id
+  [user_domain_id: <string> | default = ""]
+
+  # Openstack userid for the api.
+  # CLI flag: -swift.user-id
+  [user_id: <string> | default = ""]
+
+  # Openstack api key.
+  # CLI flag: -swift.password
+  [password: <string> | default = ""]
+
+  # Openstack user's domain id.
+  # CLI flag: -swift.domain-id
+  [domain_id: <string> | default = ""]
+
+  # Openstack user's domain name.
+  # CLI flag: -swift.domain-name
+  [domain_name: <string> | default = ""]
+
+  # Openstack project id (v2,v3 auth only).
+  # CLI flag: -swift.project-id
+  [project_id: <string> | default = ""]
+
+  # Openstack project name (v2,v3 auth only).
+  # CLI flag: -swift.project-name
+  [project_name: <string> | default = ""]
+
+  # Id of the project's domain (v3 auth only), only needed if it differs the
+  # from user domain.
+  # CLI flag: -swift.project-domain-id
+  [project_domain_id: <string> | default = ""]
+
+  # Name of the project's domain (v3 auth only), only needed if it differs from
+  # the user domain.
+  # CLI flag: -swift.project-domain-name
+  [project_domain_name: <string> | default = ""]
+
+  # Openstack Region to use eg LON, ORD - default is use first region (v2,v3
+  # auth only)
+  # CLI flag: -swift.region-name
+  [region_name: <string> | default = ""]
+
+  # Name of the Swift container to put chunks in.
+  # CLI flag: -swift.container-name
+  [container_name: <string> | default = "cortex"]
+
 # Cache validity for active index entries. Should be no higher than
 # -ingester.max-chunk-idle.
 # CLI flag: -store.index-cache-validity

docs/configuration/v1-guarantees.md

@@ -45,3 +45,4 @@ Currently experimental features are:
 - Memcached client DNS-based service discovery.
 - Delete series APIs.
 - In-memory (FIFO) and Redis cache.
+- Openstack Swift storage.

go.mod

@@ -34,6 +34,7 @@ require (
 	github.com/json-iterator/go v1.1.9
 	github.com/lib/pq v1.3.0
 	github.com/mitchellh/go-wordwrap v1.0.0
+	github.com/ncw/swift v1.0.50
 	github.com/oklog/ulid v1.3.1
 	github.com/opentracing-contrib/go-grpc v0.0.0-20180928155321-4b5a12d3ff02
 	github.com/opentracing-contrib/go-stdlib v0.0.0-20190519235532-cf7a6c988dc9

go.sum

@@ -600,6 +600,8 @@ github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f h1:KUppIJq7/+
 github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f/go.mod h1:qRWi+5nqEBWmkhHvq77mSJWrCKwh8bxhgT7d/eI7P4U=
 github.com/mxk/go-flowrate v0.0.0-20140419014527-cca7078d478f/go.mod h1:ZdcZmHo+o7JKHSa8/e818NopupXU1YMK5fe1lsApnBw=
 github.com/nakagami/firebirdsql v0.0.0-20190310045651-3c02a58cfed8/go.mod h1:86wM1zFnC6/uDBfZGNwB65O+pR2OFi5q/YQaEUid1qA=
+github.com/ncw/swift v1.0.50 h1:E01b5bVIssNhx2KnzAjMWEXkKrb8ytTqCDWY7lqmWjA=
+github.com/ncw/swift v1.0.50/go.mod h1:23YIA4yWVnGwv2dQlN4bB7egfYX6YLn0Yo/S6zZO/ZM=
 github.com/oklog/run v1.0.0 h1:Ru7dDtJNOyC66gQ5dQmaCa0qIsAUFY3sFpK1Xk8igrw=
 github.com/oklog/run v1.0.0/go.mod h1:dlhp/R75TPv97u0XWUtDeV/lRKWPKSdTuV0TZvrmrQA=
 github.com/oklog/ulid v0.0.0-20170117200651-66bb6560562f/go.mod h1:CirwcVhetQ6Lv90oh/F+FBtV6XMibvdAFo93nm5qn4U=