Enhance documentation and configuration for MVK; add starlight-heading-badges integration, update guides, and improve clarity in existing content.
This commit is contained in:
parent
ff6341edf1
commit
454e911dc7
13 changed files with 134 additions and 36 deletions
43
src/content/docs/guides/k3d/009-development-releases.md
Normal file
43
src/content/docs/guides/k3d/009-development-releases.md
Normal file
|
|
@ -0,0 +1,43 @@
|
|||
---
|
||||
title: Operational consideration
|
||||
description: Thinking about security and service management early on.
|
||||
---
|
||||
|
||||
When we create code and infrastructure for development, it is in preparation for production.
|
||||
|
||||
Breaks in development workflow ultimately delay releases to production. So adequate testing of our code helps ensure that others working with us do not have bad experiences.
|
||||
|
||||
## Continuity
|
||||
|
||||
Continuity of the development workflow is frequently underpinned by
|
||||
|
||||
* applying secure coding practices to ensure we are not leaking secure data or opening our applications to be exploited by bad actors
|
||||
* adding feature tests to prove critical functionality is maintained
|
||||
* employing health and ping checks to ensure availability in deployments
|
||||
* creating anonymized test data that is functionally representative of that in live
|
||||
|
||||
The above headlines are not exhaustive and, depending on our use case, may well become longer.
|
||||
|
||||
This can be summarized as a 'shift left' of security and testing practice into early stages of the software development lifecycle.
|
||||
|
||||
## Configuration
|
||||
|
||||
From `infctl`'s pont of view, it creates for us a `config.json` file at run time if not already present that contains :
|
||||
|
||||
```json
|
||||
{
|
||||
"log_format": "<full|basic|none>",
|
||||
"deployment_file": "<path as specified to this pipeline file>",
|
||||
"deployment_type": "<development|pre-production|production where development is the default>",
|
||||
"deployment_mode": "json"
|
||||
}
|
||||
```
|
||||
|
||||
So unless we edit this file, the default `deployment_type` is that of `development`.
|
||||
|
||||
It signifies that we have applied the above working practice.
|
||||
|
||||
Our code and pipelines can be documented, version controlled and checked from development through to production readiness.
|
||||
|
||||
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue