Skip to content

Latest commit

 

History

History
271 lines (220 loc) · 9.66 KB

README.md

File metadata and controls

271 lines (220 loc) · 9.66 KB
Raw

argus

(pronounced "ar-gus")

Build Status codecov.io Go Report Card Quality Gate Status Apache V2 License GitHub Release

Summary

The XMiDT server for storing webhooks to be used by caduceus. This service is used to replace SNS. Refer the overview docs for more information on how Argus fits into the overall picture.

Table of Contents

Code of Conduct

This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.

Details

Argus has one function: interact with a database whether it is internal or external. To enable this, Argus has two endpoints: 1) individual items, and 2) buckets containing items.

Create Individual Item - store/{bucket}/{id} endpoint

This endpoint allows for clients to PUT an object into Argus. The placeholder variables in the path must contain:

  • bucket - The name used to indicate the resource type of which the stored data represents. A plural form of a noun word should be used for stylistic reasons. By default, the following rules will be enforced:

    • Bucket names must be between 3 and 63 characters long.
    • Bucket names can consist only of lowercase letters, numbers and hyphens (-).
    • Bucket names must begin and end with a letter or number.

    If you'd like to define your own bucket validation format, check out the userInputValidation.bucketFormatRegex configuration option.

  • ID - The unique ID within the name space of the containing bucket. It is recommended this value is the resulting value of a SHA256 calculation, using the unique attributes of the object being represented (e.g. SHA256(<common_name>)). This will be used by Argus to determine uniqueness of objects being stored or updated. Argus will not accept any values for this attribute that is not a 64 character hex string containing only 0-9 and a-f.

The body must be in JSON format with the following attributes:

  • ID - Required. Must match the ID provided in the URL.
  • data - Required. RAW JSON to be stored. Opaque to Argus.
  • ttl - Optional. Specified in units of seconds. Defaults to the value of the server configuration option itemMaxTTL. If a configuration value is not specified, the value would be a day (~ 24*60^2 seconds). )

An optional header X-Xmidt-Owner can be sent to associate the object with an owner. The value of this header will be bound to the new item, which would require the same value passed in a X-Xmidt-Owner header for subsequent reads or modifications. This in effect creates a secret attribute bound to the life of newly created items. When provided, Argus validates the length of the owner string to be in the range [10,60]. If you'd like to define your own validation format, check out the userInputValidation.ownerFormatRegex configuration option.

When the header is not provided, the owner of the item will be the empty string.

The exception to the above would be an authorized request. The authorization method is not specified and is up to the implementation to decide. Authorized requests shall be allowed to update all attributes except the X-Xmidt-Owner meta attribute.

An example PUT request

PUT /store/planets/7e8c5f378b4addbaebc70897c4478cca06009e3e360208ebd073dbee4b3774e7

{
  "id": "7e8c5f378b4addbaebc70897c4478cca06009e3e360208ebd073dbee4b3774e7",
  "data": {
    "year":  1967,
     "words": ["What", "a", "Wonderful", "World"]
  },
  "ttl" : 300
}

Example responses:

HTTP/1.1 201 Created

The above response would indicate a new object has been created (no existing object with the given ID was found).

HTTP/1.1 200 OK

The above response would indicate an existing object has been updated (existing object with the given ID was found). Note that a PUT operation on an existing record may also result in "403 Forbidden" error.

Note: If a service using Argus must submit JSON data with duplicate fields, please see this issue for details on expected behavior.

List - store/{bucket} endpoint

This endpoint allows for GET to retrieve all the items in the bucket organized by the id.

An example response will look like the below where "7e8c5f378b4addbaebc70897c4478cca06009e3e360208ebd073dbee4b3774e7" is the id of the only item in this collection. An optional header X-Xmidt-Owner can be sent with the request. If supplied, only items with secrets matching the supplied value will be returned in the list. If not supplied, all items created without an owner (owner value = "") will be returned. For authorized requests, if no owner header is provided, all items for the specified bucket will be returned.

An example response:

[
  {
    "id": "7e8c5f378b4addbaebc70897c4478cca06009e3e360208ebd073dbee4b3774e7",
    "data": {
      "words": [
        "What",
        "a",
        "Wonderful",
        "World"
      ],
      "year": 1967
    },
    "ttl": 255
  }
]

Individual Item - store/{bucket}/{id} endpoint

This endpoint allows for GET, and DELETE REST methods to interact with any object that was created with the previous PUT request. An optional header X-Xmidt-Owner can be sent with the request. All requests are validated by comparing the secret stored with the requested record with the value sent in the X-Xmidt-Owner header. If the header is missing, the "" (empty string) is assigned as the item's owner during item creation. A mismatch will result in a "403 Forbidden" error. An authorized request may override this requirement, providing an administrative override. The method of authorization is not specified.

An example response:

{
  "id": "7e8c5f378b4addbaebc70897c4478cca06009e3e360208ebd073dbee4b3774e7",
  "data": {
    "words": [
      "What",
      "a",
      "Wonderful",
      "World"
    ],
    "year": 1967
  },
  "ttl": 100
}

Build

Source

In order to build from the source, you need a working Go environment with version 1.11 or greater. Find more information on the Go website.

You can directly use go get to put the Argus binary into your GOPATH:

go get github.com/xmidt-org/argus

You can also clone the repository yourself and build using make:

mkdir -p $GOPATH/src/github.com/xmidt-org
cd $GOPATH/src/github.com/xmidt-org
git clone git@github.com:xmidt-org/argus.git
cd argus
make build

Makefile

The Makefile has the following options you may find helpful:

  • make build: builds the Argus binary
  • make docker: fetches all dependencies from source and builds an Argus docker image
  • make local-docker: vendors dependencies and builds an Argus docker image (recommended for local testing)
  • make test: runs unit tests with coverage for Argus
  • make clean: deletes previously-built binaries and object files

RPM

First have a local clone of the source and go into the root directory of the repository. Then use rpkg to build the rpm:

rpkg srpm --spec <repo location>/<spec file location in repo>
rpkg -C <repo location>/.config/rpkg.conf sources --outdir <repo location>'

Docker

The docker image can be built either with the Makefile or by running a docker command. Either option requires first getting the source code.

See Makefile on specifics of how to build the image that way.

If you'd like to build it without make, follow these instructions based on your use case:

  • Local testing
go mod vendor
docker build -t argus:local -f deploy/Dockerfile .

This allows you to test local changes to a dependency. For example, you can build a Argus image with the changes to an upcoming changes to webpa-common by using the replace directive in your go.mod file like so:

replace github.com/xmidt-org/webpa-common v1.10.2-0.20200604164000-f07406b4eb63 => ../webpa-common

Note: if you omit go mod vendor, your build will fail as the path ../webpa-common does not exist on the builder container.

  • Building a specific version
git checkout v0.3.6
docker build -t argus:v0.3.6 -f deploy/Dockerfile .

Additional Info: If you'd like to stand up a XMiDT docker-compose cluster, read this.

Kubernetes

A helm chart can be used to deploy Argus to kubernetes

helm install xmidt-argus deploy/helm/argus

Deploy

For deploying a XMiDT cluster refer to getting started.

For running locally, ensure you have the binary built. If it's in your GOPATH, run:

argus

If the binary is in your current folder, run:

./argus

Contributing

Refer to CONTRIBUTING.md.