Skip to content

Commit 59a90fd

Browse files
committed
clarify production some deployment lines
1 parent d3ee31a commit 59a90fd

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

docs/deployment/production-deployment.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ Disclaimer
1010
Running a FAIR Data Point in production is a bit more involved than running one offline on your development machine.
1111
The configuration details of a production deployments depend on many factors, such as available resources and security requirements.
1212

13-
Whether you're setting up your own bare metal server or using a cloud provider that offers all kinds of managed services, you'll need to think about many of the same topics.
13+
Whether you're setting up your own bare metal server or using a cloud provider with lots of managed services, many of the same topics will need attention.
1414
Here's just a few that come to mind, in no particular order:
1515

1616
- network security
1717
- secrets storage
1818
- identity and access management (IAM)
1919
- data management (security, privacy, replication, backups)
20-
- service availability (e.g. container orchestration)
20+
- service availability (container orchestration, monitoring)
2121
- performance
2222
- audit logging
23-
- infrastructure as code
23+
- deployment automation (infrastructure as code, CI/CD)
2424
- and so on and so forth...
2525

2626
Obviously this list is far from exhaustive.
@@ -35,8 +35,8 @@ Assuming basic infrastructure hardening is already in place (see e.g. `OWASP che
3535

3636
These topics are covered by extending the :ref:`local-deployment` examples with some additional configuration.
3737

38-
Encrypted communication
39-
=======================
38+
HTTPS setup
39+
===========
4040

4141
One of the first requirements for a production deployment is to set up Transport Layer Security (TLS) to provide encrypted communication, better known as HTTPS (HTTP over TLS).
4242

@@ -50,7 +50,7 @@ TLS certificates
5050
----------------
5151

5252
In order to set up HTTPS, a valid TLS certificate is required (a.k.a. SSL certificate).
53-
For this example, we assume that a TLS certificate is already available, *on the Docker host*, for our domain ``fdp.example.com``.
53+
For this example, we assume a TLS certificate is already available, *on the Docker host*, for our domain ``fdp.example.com``.
5454

5555
Certificate files can be obtained from various sources.
5656
Our example assumes that the `certbot`_ tool was used to obtain a certificate from `Let's Encrypt`_.
@@ -129,10 +129,13 @@ Both need to be secured.
129129
Secrets
130130
=======
131131

132+
The best way to handle application secrets strongly depends on your use-case.
133+
In our minimal example we take one of the simplest approaches, viz. using environment variables.
134+
132135
List of secrets:
133136

134137
- jwt token secret key
135-
- default user accounts
138+
- default fdp user accounts
136139
- mongodb credentials
137140
- triple store credentials
138141

0 commit comments

Comments
 (0)