5 Commits

8 changed files with 45 additions and 18 deletions

View File

@@ -5,6 +5,8 @@ RUN pip install --no-cache-dir -r requirements.txt
COPY . .
RUN mkdocs build --clean
FROM nginx:alpine
COPY --from=builder /docs/site /usr/share/nginx/html
EXPOSE 80
FROM joseluisq/static-web-server:2
COPY config.toml /config.toml
COPY --from=builder /docs/site /public
ENV SWS_CONFIG_FILE=/config.toml
EXPOSE 8080

14
config.toml Normal file
View File

@@ -0,0 +1,14 @@
[general]
host = "0.0.0.0"
port = 8080
root = "/public"
log-level = "error"
compression = true
[[advanced.headers]]
source = "**/*"
[advanced.headers.headers]
"X-Frame-Options" = "DENY"
"X-Content-Type-Options" = "nosniff"
"Referrer-Policy" = "strict-origin-when-cross-origin"
"Content-Security-Policy" = "default-src 'self'; style-src 'self' 'unsafe-inline'; img-src 'self' data:;"

View File

@@ -50,7 +50,7 @@ These steps ensure that a Ceph Pool is created with appropriate Replication.
* Check with: `ceph osd pool application get default.rgw.buckets.index`
* Create a user for the RADOS Gateway:
```
```bash
ceph auth get-or-create client.rgw.k8s.svc \
mon 'allow r' \
osd 'allow rwx pool=default.rgw.buckets.data, allow rwx pool=default.rgw.buckets.index, allow rwx pool=.rgw.root, allow rwx pool=default.rgw.meta, allow rwx pool=default.rgw.log, allow rwx pool=default.rgw.control' \
@@ -72,13 +72,13 @@ These steps ensure that a Ceph Pool is created with appropriate Replication.
* Create Secret manifests for deployment to K8s:
```
```bash
kubectl create secret generic ceph-config \
--namespace=object-store \
--from-file=ceph.conf=./conf \
--dry-run=client -o yaml > ceph-config-secret.yaml
```
```
```bash
kubectl create secret generic ceph-keyring \
--namespace=object-store \
--from-file=keyring=./keyring \
@@ -95,7 +95,7 @@ These steps ensure that a Ceph Pool is created with appropriate Replication.
#### Namespace
```
```yaml
apiVersion: v1
kind: Namespace
metadata:
@@ -103,7 +103,7 @@ metadata:
```
#### Service
```
```yaml
apiVersion: v1
kind: Service
metadata:
@@ -126,7 +126,7 @@ spec:
```
#### Deployment
```
```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
@@ -263,7 +263,7 @@ spec:
Deploy this in the namespace of the appliation requiring the S3 API Access
```sh
```bash
kubectl create secret generic s3-credentials \
--namespace={application-namespace} \
--from-literal=S3_ACCESS_KEY={access-key-from-user-creation} \

View File

@@ -0,0 +1,3 @@
# Password Reset
This documentation is not written yet.

View File

@@ -1,3 +1,10 @@
# User
This group contains documentation aimed at end-users.
This group contains documentation aimed at end-users.
## Helpful Links
- [Account Management](https://fjla.uk)
- [Password Reset](https://fjla.uk/reset)
## Help Documents
- [How do I reset my password?](Account/reset-password.md)

View File

@@ -4,4 +4,4 @@ This site provides user documentation, technical documentation, configuration st
If you are a user seeking help [click here](User/index.md).
If you are an administrator seeking configuration reference [click here](Admin/index.md).
You can use the menu to navigate through help documents and guides.

View File

@@ -1,14 +1,14 @@
site_name: FJLA Documentation
nav:
- Home: index.md
- User: index.md
- User:
- Account:
- Reset or Change Password: User/Account/reset-password.md
- Admin:
- About: Admin/index.md
- Virtualisation & Orchestration:
- Combining K8s, PVE & Ceph: Admin/Virtualisation/pve-k8s-ceph-config.md
- Deploy RADOS Gateway in K8s: Admin/Virtualisation/rados-gw-in-k8s.md
theme:
name: mkdocs
color_mode: auto
user_color_mode_toggle: true
navigation_depth: 2
name: material

View File

@@ -1 +1,2 @@
mkdocs
mkdocs
mkdocs-material