version v7.2.
For up-to-date documentation, see the
latest version.
Operations Guide
2 minute read
Reference
| Document reference | Document Name |
|---|---|
| TASD | Technical Architecture and Security Document of SWaaP |
| LLD-Documentation | Low level design of Software Factory Documentation |
Introduction
The Software Factory Documentation component is part of Software Factory as a Package (SWaaP).
Software Factory Documentation is a web site that centralize Software Factory documentation and that can be deployed integrated to any Software Factory instance.
Please ensure that this component can be accessed only from your private network.
Billing and onboarding
This component shall not be billed, and onboarding shall be by default, up to “public”.
Component deployment and configuration
Requirements & Pre-requisite
- Kubernetes and Flux. See the TASD §4.1.2 Prerequisites for supported version.
Configuration
Setting Helm values
No mandatory values is required.
There’s also a list of required and optional ConfigMaps that are needed. These are described in the SF-docs package readme document
Configuring Kubernetes secrets
No specific Kubernetes secrets are required for this component.
Deployment & update procedure
The deployment and update procedures are described in the SWaaP Readme - Quick start section .
Settings
Capacity Planning
By default, the following resource requests and limits are set for the sf-docs component:
| Components | Requests | Limits |
|---|---|---|
docs.cpu | 100m | 100m |
docs.memory | 64Mi | 64Mi |
Can also update values of the chart for scaling:
autoscaling:
enabled: false
minReplicas: 1
maxReplicas: 100
targetCPUUtilizationPercentage: 80
Functional Configuration
No functional configuration.
Monitoring
No particular monitoring is suggested. Classical one with time and status respond of ingress is enough.
Metrics for supervising health of components
- GET / - API route to ensure the backend is UP and running
- (average, p99, p95) latency
- error rate on API http status code
- (average, p99, p95) token per seconds
Business Metrics
- (DAU, MAU) number of active users per day/month
Common Operations
No particular operation is suggested.