... | @@ -31,6 +31,10 @@ |
... | @@ -31,6 +31,10 @@ |
|
|
|
|
|
# Reference
|
|
# Reference
|
|
|
|
|
|
|
|
<!-- a good guide to "audit" an existing project's design: -->
|
|
|
|
<!-- https://bluesock.org/~willkg/blog/dev/auditing_projects.html -->
|
|
|
|
<!-- the following sections are partially based on that -->
|
|
|
|
|
|
## Installation
|
|
## Installation
|
|
|
|
|
|
<!-- how to setup the service from scratch -->
|
|
<!-- how to setup the service from scratch -->
|
... | @@ -39,30 +43,43 @@ |
... | @@ -39,30 +43,43 @@ |
|
|
|
|
|
<!-- this describes an acceptable level of service for this service -->
|
|
<!-- this describes an acceptable level of service for this service -->
|
|
|
|
|
|
## Design
|
|
## Design and architecture
|
|
|
|
|
|
<!-- how this is built -->
|
|
<!-- how this is built -->
|
|
<!-- should reuse and expand on the "proposed solution", it's a -->
|
|
<!-- should reuse and expand on the "proposed solution" discussed in -->
|
|
|
|
<!-- a previous RFC or the Discussion section below. it's a -->
|
|
<!-- "as-built" documented, whereas the "Proposed solution" is an -->
|
|
<!-- "as-built" documented, whereas the "Proposed solution" is an -->
|
|
<!-- "architectural" document, which the final result might differ -->
|
|
<!-- "architectural" document, which the final result might differ -->
|
|
<!-- from, sometimes significantly -->
|
|
<!-- from, sometimes significantly -->
|
|
|
|
|
|
<!-- a good guide to "audit" an existing project's design: -->
|
|
## Services
|
|
<!-- https://bluesock.org/~willkg/blog/dev/auditing_projects.html -->
|
|
|
|
|
|
<!-- open ports, daemons, cron jobs -->
|
|
|
|
|
|
|
|
## Storage
|
|
|
|
|
|
|
|
<!-- databases? plain text file? the frigging blockchain? memory? -->
|
|
|
|
|
|
|
|
## Queues
|
|
|
|
|
|
|
|
<!-- email queues, job queues, schedulers -->
|
|
|
|
|
|
|
|
## Interfaces
|
|
|
|
|
|
|
|
<!-- e.g. web APIs, commandline clients, etc -->
|
|
|
|
|
|
|
|
## Authentication
|
|
|
|
|
|
|
|
<!-- SSH? LDAP? standalone? -->
|
|
|
|
|
|
|
|
## Implementation
|
|
|
|
|
|
<!-- things to evaluate here:
|
|
<!-- programming languages, frameworks, versions, license -->
|
|
|
|
|
|
* services
|
|
## Related services
|
|
* storage (databases? plain text files? cloud/S3 storage?)
|
|
|
|
* queues (e.g. email queues, job queues, schedulers)
|
|
|
|
* interfaces (e.g. webserver, commandline)
|
|
|
|
* authentication (e.g. SSH, LDAP?)
|
|
|
|
* programming languages, frameworks, versions
|
|
|
|
* dependent services (e.g. authenticates against LDAP, or requires
|
|
|
|
git pushes)
|
|
|
|
* deployments: how is code for this deployed (see also Installation)
|
|
|
|
|
|
|
|
how is this thing built, basically? -->
|
|
<!-- dependent services (e.g. authenticates against LDAP, or requires -->
|
|
|
|
<!-- git pushes) -->
|
|
|
|
|
|
## Issues
|
|
## Issues
|
|
|
|
|
... | | ... | |