Versio.io operating manual (template)
Last update: [date]
Info
This template is designed to help you write an operations manual to ensure the professional and secure operation of the Versio.io Managed platform.
Document history
| Date | Autor | Note |
|---|---|---|
| 2025-03-10 | john.doe@company.com | Initial creation |
| 2025-03-20 | john.doe@company.com | Add backup description |
| 2025-03-21 | peter.meyer@company.com | Quality assurance |
Table: Overview document history
Responsibility & contact person
| Team / Person | Role | Contact options |
|---|---|---|
| Team A | Infrastructure up to OS level | team-a@company.com |
| John Doe | Application operation | john.doe@company.com |
| Team B | Backup | team-b@company.com |
Table: Overview responsibility & contact person
Installation
Detailed installation instructions for a Versio.io Managed instance are available in the product documentation: https://live.versio.io/doc/setup-managed/#installation
The following customisations were made during installation:
- ...
- ...
- ...
Update
Managed platform instance
Detailed update instructions for a Versio.io Managed instance are available in the product documentation: https://live.versio.io/doc/setup-managed/#update
The following customer-specific points must be observed during a backup and restore:
- ...
- ...
- ...
Tip
Use the batch job monitoring of the Versio.io platform to monitor the update execution and to be informed in case of failing backups.
SSL certificates
A customised SS certificate should be set up. As the validity of the certificate is limited, it must be renewed at regular intervals. Detailed documentation can be found in the product documentation: https://live.versio.io/doc/setup-managed/#ssl-certificate
Tip
The SSL certificates of the Versio.io Managed Instance can be recorded with Versio.io, the validity period checked and an alarm triggered when the SSL certificate expires.
AI content
The AI content contains data on the product life cycle and IT vulnerabilities and should be updated at least once a day using an automated cronjob. A detailed description can be found in the product documentation: https://live.versio.io/doc/setup-managed/#update-ai-content
Tip
Use the batch job monitoring of the Versio.io platform to monitor the update execution and to be informed in case of failing backups.
Backup & restore
Detailed backup and restore instructions for a Versio.io Managed instance can be found in the product documentation: managed/#https://live.versio.io/doc/setup-managed/#backup-restore
Regular restore tests should ensure that a restore can be carried out successfully in the event of a failure:
| Date | Tester | Status | Note |
|---|---|---|---|
| 2025-03-12 | John Doe | successful | Test environment |
| 2025-06-12 (planned) |
Table: Overview executed and planned restore tests
Tip
Use the batch job monitoring of the Versio.io platform to monitor the backup execution and to be informed in case of failing backups.
Trouble shooting
The following is a list of known problem situations and solution options from previous Versio.io operating practice:
| Problem situation | Solution option |
|---|---|
| The problem descripton | A technical solution to solve the problem |
Table: Overview known problems and solutions
Support & incident request
Support and incident requests for the Versio.io platform are supported as follows:
| Support level | Contact | Note |
|---|---|---|
| First level | https://myservice.company.com | Internal service desk |
| Second level | +43 (142) 92384284 or versio-aot@company.com | Application operation team |
| Third level | https://live.versio.io/feedback | Software vendor |
Table: Overview access data
Third-party access data
The following accesses for third-party systems are required for the operation of Versio.io. These are documented here as appropriate:
| System | Location where the access data is stored | Note |
|---|---|---|
| Versio.io Container Registry | Team A KeePass database | registry.versio.io |
| Backup file system | Team A KeePass database | //130.20.10.80/project/versio.io |
Table: Overview access data