diff --git a/KNEL-Contract-Template-Variables.env b/KNEL-Contract-Template-Variables.env new file mode 100644 index 0000000..f1b2d05 --- /dev/null +++ b/KNEL-Contract-Template-Variables.env @@ -0,0 +1,2 @@ +export SLA_PENALTY="" +export SLO_PENALTY="" \ No newline at end of file diff --git a/KNEL-Services-Corporate.md b/KNEL-Services-Corporate.md deleted file mode 100644 index 20462be..0000000 --- a/KNEL-Services-Corporate.md +++ /dev/null @@ -1 +0,0 @@ -## Applications/Systems/Services Offered \ No newline at end of file diff --git a/KNEL-Services-LOB.md b/KNEL-Services-LOB.md deleted file mode 100644 index e885955..0000000 --- a/KNEL-Services-LOB.md +++ /dev/null @@ -1,26 +0,0 @@ -# KNEL Provided Services to TSYS Group Core Components - -## Introduction - -In addition to all of the services KNEL provides (generally) to all the nom core TSYS Group compoments , KNEL provides a number of component specific services to TSYS Group Core Compoments. - -## HFNFC - -- Umbrel - -#% HFNOC - -- Multi Tenant Governance System -- SLURM - -## Suborbital Systems - -- EzEDA imstancr (compute / storage) -- Nvidia cluster -- - -## Per component offerings - - -| LOB business specific application compute/storage capacity on the KNEL Coolify bizapp instance. -- Easy Appointments \ No newline at end of file diff --git a/MakeBook.sh b/MakeBook.sh new file mode 100644 index 0000000..dff9833 --- /dev/null +++ b/MakeBook.sh @@ -0,0 +1,14 @@ +#!/bin/bash +# Put together the KNEL services contract template + +set -euo pipefail + +# Pull in contract variables +source ./KNEL-Contract-Template-Variables.env + +# Run mustache to expand variables +# .... + +bash RenderTemplates.sh +bash RenderCSVToMarkdown.sh +bash build-book.sh \ No newline at end of file diff --git a/README.md b/README.md index fed5d08..42ab247 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ # KNELContracts +This is an mdbook repository for the + +Turnkey Network Systems LLC Management Company : Known Element Enterprises LLC + +contract (template) for services it provides to Turnkey Network Systems LLC and various super cell/series LLCs under Turnkey Network Systems LLC. + +Each individual LLC (and Turnkey Network Systems LLC) will have a private repository with an (filled out template) and executed copy of this contract (and operating agreement). + + diff --git a/PrepMarkdown.sh b/RenderCSVToMarkdown.sh similarity index 96% rename from PrepMarkdown.sh rename to RenderCSVToMarkdown.sh index 5db4a64..015ea33 100644 --- a/PrepMarkdown.sh +++ b/RenderCSVToMarkdown.sh @@ -1,15 +1,5 @@ #!/bin/bash -set -euo pipefail - -# Put together the KNEL IT/business ops contract - -# Pull in contract variables -# source ./KNEL-Contract-Variables.env - -# Run mustache to expand variables -# .... - # Render CSV to markdown table COOLIFY_TO_ALL="src/services-coolify-techops-all.md" diff --git a/RenderTemplates.sh b/RenderTemplates.sh new file mode 100644 index 0000000..7ab7ee1 --- /dev/null +++ b/RenderTemplates.sh @@ -0,0 +1,9 @@ +#!/bin/bash + +MUSTACHE_PATH="../vendor/" + +for input_file in $(ls -1 contract-inputs/*.md); +do + OUTPUT_FILE_NAME="$(echo $input_file | awk -F '/' '{print $2}')" + $MUSTACHE_PATH $input_file > $OUTPUT_FILE_NAME +done \ No newline at end of file diff --git a/build-book.sh b/build-book.sh new file mode 100644 index 0000000..5131b64 --- /dev/null +++ b/build-book.sh @@ -0,0 +1,3 @@ +#/bin/bash + +mdbook build && mdbook serve \ No newline at end of file diff --git a/contract-inputs/parties.md b/contract-inputs/parties.md new file mode 100644 index 0000000..8695add --- /dev/null +++ b/contract-inputs/parties.md @@ -0,0 +1,6 @@ + +## Parties To The Contract + +### Party 1 + +### Party 2 diff --git a/contract-inputs/terms-length.md b/contract-inputs/terms-length.md new file mode 100644 index 0000000..28ee84b --- /dev/null +++ b/contract-inputs/terms-length.md @@ -0,0 +1,6 @@ + +## Contract Length + +This is the input file. It will get rendered into the output file of same name in src/ + +- Contract Length : {{CONTRACT_LENGTH}} \ No newline at end of file diff --git a/contract-inputs/terms-payment.md b/contract-inputs/terms-payment.md new file mode 100644 index 0000000..3b3f1b4 --- /dev/null +++ b/contract-inputs/terms-payment.md @@ -0,0 +1,6 @@ + +## Payment Terms + +This is the input file. It will get rendered into the output file of same name in src/ + +- The services are offered for an all inclusive delivered price of {{PRICE}} which must be paid {{PAYMENT_FREQUENCY}} \ No newline at end of file diff --git a/contract-inputs/terms-slo.md b/contract-inputs/terms-slo.md new file mode 100644 index 0000000..fd0b8e0 --- /dev/null +++ b/contract-inputs/terms-slo.md @@ -0,0 +1,12 @@ +## SLA/SLO + +This is the input file. It will get rendered into the output file of same name in src/ + +- The services listed in the section titled "Services Offered by KNEL" are offered with the following 🎃 + - {{SERVICES_SLA}} + - {{SERVICES_SLO}} + +- Penalities for not hitting the SLA/SLO + + - {{SLA_PENALTY}} + - {{SLO_PENALTY}} diff --git a/service-csv/services-cloudron-all.csv b/service-csv/services-cloudron-all.csv index fefa7d0..69f3998 100644 --- a/service-csv/services-cloudron-all.csv +++ b/service-csv/services-cloudron-all.csv @@ -24,7 +24,6 @@ Web Design/Mockup,[Penpot](https://penpot.app/),[KNEL Mockup](https://design.kno Time series/alert manager,[Promethus Alert Manager](https://prometheus.io/docs/alerting/latest/alertmanager/),[KNEL PromAM](https://alertmanager.knownelement.com/login?redirect=/) Meeting coordination,[Rally](https://github.com/lukevella/rallly),[KNEL Meeting Scheduler](https://companymeetings.knownelement.com/) Project/task management,[Redmine](https://www.redmine.org/),[KNEL Project](https://projects.knownelement.com/) -Webmail,[Roundcube](https://roundcube.net/),[KNEL Webmail](https://webmail.knownelement.com/) Web Search,[SearXNG](https://docs.searxng.org/),[KNEL Websearch](https://websearch.knownelement.com/) IT Asset Management,[Snipe-IT](https://snipeitapp.com/),[KNEL Asset Management](https://assets.knownelement.com/login) Environment data management system,[Emoncms](https://emoncms.org/),Being deployed to [KNEL Emoncms](https://emoncms.knownelement.com/) @@ -42,4 +41,5 @@ Forms Manager,[EasyForms](https://easyforms.dev/),[KNEL Forms](https://forms.kno Advertising Network,[Revive](https://www.revive-adserver.com/),[KNEL Ads](https://ads.knownelement.com/www/admin/index.php) IP Address Management,[phpipam](https://phpipam.net/),Being deployed to [KNEL IPAM](https://ipam.knownelement.com/) Mailing List,[phplist](https://www.phplist.com/),Being deployed to [KNEL Mailing List](https://lists.knownelement.com) -Web office,[Nextcloud](https://nextcloud.com/),[KNEL Nextcloud](https://nextcloud.knownelement.com/) \ No newline at end of file +Web office,[Nextcloud](https://nextcloud.com/),[KNEL Nextcloud](https://nextcloud.knownelement.com/) +Webmail/Inbound/outbound E-mai (with 1gb quota aggregate across all mailboxes) (for non customer/corporate/non-automated use only),[Roundcube](https://roundcube.net/),[KNEL Webmail](https://webmail.knownelement.com/) \ No newline at end of file diff --git a/service-csv/services-coolify-randd-lob.csv b/service-csv/services-coolify-randd-lob.csv index a57f782..7f7b6ab 100644 --- a/service-csv/services-coolify-randd-lob.csv +++ b/service-csv/services-coolify-randd-lob.csv @@ -1 +1 @@ -coming soon,coming soon,coming soon \ No newline at end of file +LOB bizapp compute/storage,TBD,TBD \ No newline at end of file diff --git a/service-csv/services-coolify-techops-all.csv b/service-csv/services-coolify-techops-all.csv index a57f782..94e8c10 100644 --- a/service-csv/services-coolify-techops-all.csv +++ b/service-csv/services-coolify-techops-all.csv @@ -1 +1 @@ -coming soon,coming soon,coming soon \ No newline at end of file +LLC Governance,TBD,TBD \ No newline at end of file diff --git a/service-csv/services-kneldc-lob.csv b/service-csv/services-kneldc-lob.csv index a57f782..6c45f9f 100644 --- a/service-csv/services-kneldc-lob.csv +++ b/service-csv/services-kneldc-lob.csv @@ -1 +1,2 @@ -coming soon,coming soon,coming soon \ No newline at end of file +Storage/Compute/Network HPC Runtime Resources, SLURM, TBD +Electronic Design Automation,[EzEDA](https://ezeda.org), TBD \ No newline at end of file diff --git a/servicestomerge.md b/servicestomerge.md deleted file mode 100644 index d9de78b..0000000 --- a/servicestomerge.md +++ /dev/null @@ -1,11 +0,0 @@ -- Email (inbound, outbound for non-automated email only) (with a total of 1gb quota aggregate across all mailboxes) (for non customer , corporate, non-automated use only). - - -- Various other business specific back office or middleware functions as negotiated between KNEL and {{PARTY2}}. - -- Serverless runtime (TBD) -- Billing (Killbill) -- Payment Gateway (Hyperswitch) -- API Gateway (TBD) - -- backups (of KNEL microservices and wordpress/grav site and bizapp application code/data (stored in KNEL microservice systems) \ No newline at end of file diff --git a/src/SUMMARY.md b/src/SUMMARY.md index dbf5048..0f23917 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -12,6 +12,7 @@ - [Coolify R&D LOB Bespoke](./services-coolify-randd-lob.md) - [KNEL Datacenter All TSYS Group](./services-kneldc-all.md) - [KNEL Datacenter LOB Bespoke](./services-kneldc-lob.md) +- [General Services](./services-general.md) # Terms diff --git a/src/parties.md b/src/parties.md new file mode 100644 index 0000000..8695add --- /dev/null +++ b/src/parties.md @@ -0,0 +1,6 @@ + +## Parties To The Contract + +### Party 1 + +### Party 2 diff --git a/src/services-coolify-rand-all.md b/src/services-coolify-rand-all.md deleted file mode 100644 index f22ed87..0000000 --- a/src/services-coolify-rand-all.md +++ /dev/null @@ -1,5 +0,0 @@ -# Services hosted in KNEL Coolify R&D Instance, offered to all TSYS Group components - -|Function|Vendor|Instance| -|---|---|---| -|coming soon|coming soon|coming soon| diff --git a/src/services-coolify-rand-lob.md b/src/services-coolify-rand-lob.md deleted file mode 100644 index 2210b3f..0000000 --- a/src/services-coolify-rand-lob.md +++ /dev/null @@ -1,5 +0,0 @@ -# Services hosted in KNEL Coolify R&D Instance, offered to certain TSYS Group components under bespoke arrangement - -|Function|Vendor|Instance| -|---|---|---| -|coming soon|coming soon|coming soon| diff --git a/src/services-general.md b/src/services-general.md new file mode 100644 index 0000000..893a18a --- /dev/null +++ b/src/services-general.md @@ -0,0 +1,4 @@ + +# General Services Offered + +- backups (of KNEL microservices and wordpress/grav site and bizapp application code/data (stored in KNEL microservice systems) \ No newline at end of file diff --git a/src/terms-length.md b/src/terms-length.md index 8180f03..28ee84b 100644 --- a/src/terms-length.md +++ b/src/terms-length.md @@ -1 +1,6 @@ -# Contract Length + +## Contract Length + +This is the input file. It will get rendered into the output file of same name in src/ + +- Contract Length : {{CONTRACT_LENGTH}} \ No newline at end of file diff --git a/src/terms-payment.md b/src/terms-payment.md index 982601d..3b3f1b4 100644 --- a/src/terms-payment.md +++ b/src/terms-payment.md @@ -1,3 +1,6 @@ -# Payment Terms + +## Payment Terms + +This is the input file. It will get rendered into the output file of same name in src/ - The services are offered for an all inclusive delivered price of {{PRICE}} which must be paid {{PAYMENT_FREQUENCY}} \ No newline at end of file diff --git a/src/terms-slaslo.md b/src/terms-slaslo.md index 05c19a0..e69de29 100644 --- a/src/terms-slaslo.md +++ b/src/terms-slaslo.md @@ -1,10 +0,0 @@ -# SLA/SLO - -- The services listed in the section titled "Services Offered by KNEL" are offered with the following 🎃 - - {{SERVICES_SLA}} - - {{SERVICES_SLO}} - -- Penalities for not hitting the SLA/SLO - - - {{SLA_PENALTY}} - - {{SLO_PENALTY}} \ No newline at end of file diff --git a/src/terms-slo.md b/src/terms-slo.md new file mode 100644 index 0000000..fd0b8e0 --- /dev/null +++ b/src/terms-slo.md @@ -0,0 +1,12 @@ +## SLA/SLO + +This is the input file. It will get rendered into the output file of same name in src/ + +- The services listed in the section titled "Services Offered by KNEL" are offered with the following 🎃 + - {{SERVICES_SLA}} + - {{SERVICES_SLO}} + +- Penalities for not hitting the SLA/SLO + + - {{SLA_PENALTY}} + - {{SLO_PENALTY}}