Skip to content

Commit

Permalink
Document how the service handles IDs and datetimes
Browse files Browse the repository at this point in the history
As we work through schema design and migrations, it would be nice to
know how we handle certain common things, like IDs and datetime.

Let's include those in the README.md next to the design goals. This was
mentioned while working through schemas in #84.
  • Loading branch information
rhmdnd committed Jul 27, 2022
1 parent 4587e02 commit 8dc9651
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,28 @@ The service should be deployed with containers, ideally for Kubernetes-based
platforms. Also, the service will initially store compliance data for
Kubernetes deployments.

## Design Goals
## Design

The following goals and decisions are documented here to establish consistency
within the service. Changes to this list should require an open issue for
discussion.

### Goals

1. Object models specific to compliance concepts must remain generic, so the
service can be flexible for other implementations
2. Any tools required to run the service must be automated or scripted, and
included in this repository with documentation

### Decisions

1. Each entity must contain a unique identifier, where it is unique within the
system. A version 4 UUID as defined by [RFC
4122](https://datatracker.ietf.org/doc/html/rfc4122) is sufficient for uniqueness.
2. Dates and times must be Coordinated Universal Time (UTC) without reference
to a timezone. Clients are responsible for converting to locale-specific
date formats.

## Architecture

The service will use a relational database for persisting data. Data will be
Expand Down

0 comments on commit 8dc9651

Please sign in to comment.