Wardrobe
/
rediOps
mirror of https://github.com/meerkat-manor/rediOps.git
5
0
Fork 0
Code Issues Projects Releases Wiki Activity

Spelling corrections

documentation
meerkat-manor 2023-07-23 21:57:08 +10:00
parent 80e8fdc9ab
commit c8a71c9be5
5 changed files with 66 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.vscode/settings.json vendored 100644
View File

@ -0,0 +1,12 @@
{
"cSpell.words": [
"cmdb",
"initialisation",
"Qaskx",
"rediops",
"synchronised"
],
"cSpell.ignoreWords": [
"apip"
]
}

8
docs/analysis_start.md
View File

@ -14,8 +14,8 @@ service domain scope have already been agreed before starting
to define the API. to define the API.
Knowing the information to fetch or tasks that need to be performed Knowing the information to fetch or tasks that need to be performed
will assist in comleting the API specification. This information will assist in completing the API specification. This information
could be captured in the API specification so as to avoid duplciate could be captured in the API specification so as to avoid duplicate
sources of information that needs to be synchronised. sources of information that needs to be synchronised.
Information in the OpenAPI specification can be extracted and rendered Information in the OpenAPI specification can be extracted and rendered
@ -55,7 +55,7 @@ sequenceDiagram
``` ```
When creating the OpenAPI specification the information to include: When creating the OpenAPI specification the information to include:
* Summary and abtstract * Summary and abstract
* Version * Version
* Descriptions for fields * Descriptions for fields
* Field attributes including mandatory, type, enumeration and rules such as size * Field attributes including mandatory, type, enumeration and rules such as size
@ -82,7 +82,7 @@ server code is built.
# Reading Notes # Reading Notes
The ApiCurio and Github components can be substitued for The ApiCurio and Github components can be substituted for
other software products uch as Swagger Editor and Bitbucket other software products uch as Swagger Editor and Bitbucket
that provide similar capabilities. that provide similar capabilities.

4
docs/developer_update.md
View File

@ -1,7 +1,7 @@
# Developer update flow # Developer update flow
_This document is intended to cover the scenario where the **rediops** _This document is intended to cover the scenario where the **devops**
contents change including references to OpenAPI specifications._ file contents change including references to OpenAPI specifications._
_This document under construction._ _This document under construction._

48
docs/developers_client_start.md
View File

@ -20,7 +20,7 @@ The assumptions for this documents are:
### Automation ### Automation
The sequence of automation activity using **rediops** and **qaskx-cli** is The sequence of automation activity using **devops** file and **qaskx-cli** is
as follows. as follows.
The Qaskx command line tool needs to be installed on the developer machine The Qaskx command line tool needs to be installed on the developer machine
@ -35,9 +35,9 @@ sequenceDiagram
participant qaskx as qaskx-cli participant qaskx as qaskx-cli
participant cmdb as CMDB participant cmdb as CMDB
participant git as Github participant git as Github
link git: GitHub @ https://github.com/meerkat-manor/rediOps link git: GitHub @ https://github.com/meerkat-manor/devops
participant oas3f as OpenAPI file participant oas3f as OpenAPI file
participant rediops as rediops file participant devops as devops file
participant apip as API portal participant apip as API portal
dev ->>+ vsc: start IDE dev ->>+ vsc: start IDE
@ -46,44 +46,44 @@ sequenceDiagram
vsc ->>+ git : vsc ->>+ git :
git -->>- vsc : Cloned, project opened git -->>- vsc : Cloned, project opened
Note over git, rediops: The OpenAPI and redops files are stored in Git Note over git, devops: The OpenAPI and devops files are stored in Git
vsc ->>+ term: start vsc ->>+ term: start
term ->>+ qaskx: New CI term ->>+ qaskx: New CI
qaskx ->>+ rediops: Read qaskx ->>+ devops: Read
rediops -->>- qaskx: Contents devops -->>- qaskx: Contents
qaskx ->>+ oas3f: Read qaskx ->>+ oas3f: Read
oas3f -->>- qaskx: Contents oas3f -->>- qaskx: Contents
Note over cmdb, git: qaskx rediops ci cmd Note over cmdb, git: qaskx devops ci cmd
qaskx ->>+ cmdb: qaskx ->>+ cmdb:
cmdb -->>- qaskx: New CI value cmdb -->>- qaskx: New CI value
qaskx -) rediops: Update CI entry qaskx -) devops: Update CI entry
qaskx -->>- term: Success qaskx -->>- term: Success
term ->>+ qaskx: Generate code term ->>+ qaskx: Generate code
Note over qaskx, cmdb: qaskx gen client cmd Note over qaskx, cmdb: qaskx gen client cmd
qaskx ->>+ rediops: Read qaskx ->>+ devops: Read
rediops -->>- qaskx: Contents devops -->>- qaskx: Contents
qaskx ->>+ oas3f: Read qaskx ->>+ oas3f: Read
oas3f -->>- qaskx: Contents oas3f -->>- qaskx: Contents
qaskx -) qaskx: Auto generate client code qaskx -) qaskx: Auto generate client code
qaskx -) qaskx: Auto generate sequence diagram qaskx -) qaskx: Auto generate sequence diagram
qaskx -) qaskx: Auto generate gateway infra qaskx -) qaskx: Auto generate gateway infra
qaskx -) qaskx: Auto generate feature flags qaskx -) qaskx: Auto generate feature flags
qaskx -) rediops: Auto update entries, including build, test qaskx -) devops: Auto update entries, including build, test
qaskx -->>- term: Success qaskx -->>- term: Success
alt Regsiter API if not already done alt Register API if not already done
term ->>+ qaskx: Register API term ->>+ qaskx: Register API
Note over cmdb, git: qaskx rediops register cmd Note over cmdb, git: qaskx devops register cmd
qaskx ->>+ rediops: Read qaskx ->>+ devops: Read
rediops -->>- qaskx: Contents devops -->>- qaskx: Contents
qaskx ->>+ oas3f: Read qaskx ->>+ oas3f: Read
oas3f -->>- qaskx: Contents oas3f -->>- qaskx: Contents
qaskx ->>+ apip: qaskx ->>+ apip:
apip -->>- qaskx: Registered apip -->>- qaskx: Registered
qaskx -) rediops: Auto update API entry qaskx -) devops: Auto update API entry
qaskx -->>- term: Success qaskx -->>- term: Success
end end
@ -101,7 +101,7 @@ sequenceDiagram
### Manual ### Manual
The equivalent sequence of manual activity, non qaskx actions is as follows. The equivalent sequence of manual activity, non qaskx actions is as follows.
The **rediops** file is still used. Without **rediops** file you will The **devops** file is still used. Without **devops** file you will
follow whatever your existing process is and recorded the necessary follow whatever your existing process is and recorded the necessary
details in various documents details in various documents
@ -117,9 +117,9 @@ sequenceDiagram
link vsc: Visual Studio @ https://code.visualstudio.com/ link vsc: Visual Studio @ https://code.visualstudio.com/
participant term as Terminal participant term as Terminal
participant git as Github participant git as Github
link git: GitHub @ https://github.com/meerkat-manor/rediOps link git: GitHub @ https://github.com/meerkat-manor/devops
participant oas3f as OpenAPI file participant oas3f as OpenAPI file
participant rediops as rediops file participant devops as devops file
participant oas3 as OpenAPI tool participant oas3 as OpenAPI tool
participant apip as API portal participant apip as API portal
@ -129,7 +129,7 @@ sequenceDiagram
cmdb -->> cmdb: Create CI entry cmdb -->> cmdb: Create CI entry
cmdb -->>- dev: Close, noting CI value cmdb -->>- dev: Close, noting CI value
Note over git, rediops: The rediops file is stored in Git Note over git, devops: The devops file is stored in Git
dev ->>+ vsc: start IDE dev ->>+ vsc: start IDE
@ -137,7 +137,7 @@ sequenceDiagram
vsc ->>+ git : vsc ->>+ git :
git -->>- vsc : Cloned, project opened git -->>- vsc : Cloned, project opened
vsc -) rediops: Update CI entry vsc -) devops: Update CI entry
vsc ->>+ term: start vsc ->>+ term: start
Note over git, oas3: Set generation parameters Note over git, oas3: Set generation parameters
@ -152,14 +152,14 @@ sequenceDiagram
vsc -) vsc: Manually write Gateway infra vsc -) vsc: Manually write Gateway infra
vsc -) vsc: Manually write feature flags vsc -) vsc: Manually write feature flags
alt Regsiter API if not already done alt Register API if not already done
dev ->>+ apip: Register API dev ->>+ apip: Register API
apip -->>- dev: Registered apip -->>- dev: Registered
end end
vsc -) rediops: Manually update entries vsc -) devops: Manually update entries
vsc ->>+ git: Commit vsc ->>+ git: Commit
git --) git: Trigger GitActions for lint, gateway, features, etc git --) git: Trigger GitActions for lint, gateway, features, etc
@ -182,6 +182,6 @@ expected to have been done.
# Reading Notes # Reading Notes
The Visual Studio Code, CMDB and Github components can be substitued for The Visual Studio Code, CMDB and Github components can be substituted for
other software products such IntelliJ and Bitbucket. other software products such IntelliJ and Bitbucket.

48
docs/developers_server_start.md
View File

@ -21,7 +21,7 @@ The assumptions for this documents are:
### Automation ### Automation
The sequence of automation activity using **rediops** and **qaskx-cli** is The sequence of automation activity using **devops** file and **qaskx-cli** is
as follows. as follows.
The Qaskx command line tool needs to be installed on the developer machine The Qaskx command line tool needs to be installed on the developer machine
@ -36,9 +36,9 @@ sequenceDiagram
participant qaskx as qaskx-cli participant qaskx as qaskx-cli
participant cmdb as CMDB participant cmdb as CMDB
participant git as Github participant git as Github
link git: GitHub @ https://github.com/meerkat-manor/rediOps link git: GitHub @ https://github.com/meerkat-manor/devops
participant oas3f as OpenAPI file participant oas3f as OpenAPI file
participant rediops as rediops file participant devops as devops file
participant apip as API portal participant apip as API portal
dev ->>+ vsc: start IDE dev ->>+ vsc: start IDE
@ -47,44 +47,44 @@ sequenceDiagram
vsc ->>+ git : vsc ->>+ git :
git -->>- vsc : Cloned, project opened git -->>- vsc : Cloned, project opened
Note over git, rediops: The OpenAPI and rediops files are stored in Git Note over git, devops: The OpenAPI and devops files are stored in Git
vsc ->>+ term: start vsc ->>+ term: start
term ->>+ qaskx: New CI term ->>+ qaskx: New CI
qaskx ->>+ rediops: Read qaskx ->>+ devops: Read
rediops -->>- qaskx: Contents devops -->>- qaskx: Contents
qaskx ->>+ oas3f: Read qaskx ->>+ oas3f: Read
oas3f -->>- qaskx: Contents oas3f -->>- qaskx: Contents
Note over cmdb, git: qaskx rediops ci cmd Note over cmdb, git: qaskx devops ci cmd
qaskx ->>+ cmdb: qaskx ->>+ cmdb:
cmdb -->>- qaskx: New CI value cmdb -->>- qaskx: New CI value
qaskx -) rediops: Update CI entry qaskx -) devops: Update CI entry
qaskx -->>- term: Success qaskx -->>- term: Success
term ->>+ qaskx: Generate code term ->>+ qaskx: Generate code
Note over qaskx, cmdb: qaskx gen server cmd Note over qaskx, cmdb: qaskx gen server cmd
qaskx ->>+ rediops: Read qaskx ->>+ devops: Read
rediops -->>- qaskx: Contents devops -->>- qaskx: Contents
qaskx ->>+ oas3f: Read qaskx ->>+ oas3f: Read
oas3f -->>- qaskx: Contents oas3f -->>- qaskx: Contents
qaskx -) qaskx: Auto generate server code qaskx -) qaskx: Auto generate server code
qaskx -) qaskx: Auto generate sequence diagram qaskx -) qaskx: Auto generate sequence diagram
qaskx -) qaskx: Auto generate gateway infra qaskx -) qaskx: Auto generate gateway infra
qaskx -) qaskx: Auto generate feature flags qaskx -) qaskx: Auto generate feature flags
qaskx -) rediops: Auto update entries, including build, test qaskx -) devops: Auto update entries, including build, test
qaskx -->>- term: Success qaskx -->>- term: Success
alt Regsiter API if not already done alt Register API if not already done
term ->>+ qaskx: Register API term ->>+ qaskx: Register API
Note over cmdb, git: qaskx rediops register cmd Note over cmdb, git: qaskx devops register cmd
qaskx ->>+ rediops: Read qaskx ->>+ devops: Read
rediops -->>- qaskx: Contents devops -->>- qaskx: Contents
qaskx ->>+ oas3f: Read qaskx ->>+ oas3f: Read
oas3f -->>- qaskx: Contents oas3f -->>- qaskx: Contents
qaskx ->>+ apip: qaskx ->>+ apip:
apip -->>- qaskx: Registered apip -->>- qaskx: Registered
qaskx -) rediops: Auto update API entry qaskx -) devops: Auto update API entry
qaskx -->>- term: Success qaskx -->>- term: Success
end end
@ -102,7 +102,7 @@ sequenceDiagram
### Manual ### Manual
The equivalent sequence of manual activity, non qaskx actions is as follows. The equivalent sequence of manual activity, non qaskx actions is as follows.
The **rediops** file is still used. Without **rediops** file you will The **devops** file is still used. Without **devops** file you will
follow whatever your existing process is and recorded the necessary follow whatever your existing process is and recorded the necessary
details in various documents details in various documents
@ -118,9 +118,9 @@ sequenceDiagram
link vsc: Visual Studio @ https://code.visualstudio.com/ link vsc: Visual Studio @ https://code.visualstudio.com/
participant term as Terminal participant term as Terminal
participant git as Github participant git as Github
link git: GitHub @ https://github.com/meerkat-manor/rediOps link git: GitHub @ https://github.com/meerkat-manor/devops
participant oas3f as OpenAPI file participant oas3f as OpenAPI file
participant rediops as rediops file participant devops as devops file
participant oas3 as OpenAPI tool participant oas3 as OpenAPI tool
participant apip as API portal participant apip as API portal
@ -130,7 +130,7 @@ sequenceDiagram
cmdb -->> cmdb: Create CI entry cmdb -->> cmdb: Create CI entry
cmdb -->>- dev: Close, noting CI value cmdb -->>- dev: Close, noting CI value
Note over git, rediops: The OpenAPI and redops files are stored in Git Note over git, devops: The OpenAPI and devops files are stored in Git
dev ->>+ vsc: start IDE dev ->>+ vsc: start IDE
@ -138,7 +138,7 @@ sequenceDiagram
vsc ->>+ git : vsc ->>+ git :
git -->>- vsc : Cloned, project opened git -->>- vsc : Cloned, project opened
vsc -) rediops: Update CI entry vsc -) devops: Update CI entry
vsc ->>+ term: start vsc ->>+ term: start
Note over git, oas3: Set generation parameters Note over git, oas3: Set generation parameters
@ -153,14 +153,14 @@ sequenceDiagram
vsc -) vsc: Manually write Gateway infra vsc -) vsc: Manually write Gateway infra
vsc -) vsc: Manually write feature flags vsc -) vsc: Manually write feature flags
alt Regsiter API if not already done alt Register API if not already done
dev ->>+ apip: Register API dev ->>+ apip: Register API
apip -->>- dev: Registered apip -->>- dev: Registered
end end
vsc -) rediops: Manually update entries vsc -) devops: Manually update entries
vsc ->>+ git: Commit vsc ->>+ git: Commit
git --) git: Trigger GitActions for lint, gateway, features, etc git --) git: Trigger GitActions for lint, gateway, features, etc
@ -180,6 +180,6 @@ response results.
# Reading Notes # Reading Notes
The Visual Studio Code, CMDB and Github components can be substitued for The Visual Studio Code, CMDB and Github components can be substituted for
other software products such IntelliJ and Bitbucket. other software products such IntelliJ and Bitbucket.