From 08fc4dfe671ae616c30ffc02373d6ab273ad5720 Mon Sep 17 00:00:00 2001 From: Charles N Wyble Date: Mon, 6 Jan 2025 14:39:30 -0600 Subject: [PATCH] coming along very nicely now --- CreateDocument.sh | 18 ++++++++++++++++++ KNEL-Contract-Template-Variables.env | 16 ++++++++++++++-- build-book.sh => RenderBook.sh | 0 RenderTemplates.sh | 8 ++++++-- contract-inputs/parties.md | 4 ++++ contract-inputs/terms-length.md | 2 -- contract-inputs/terms-payment.md | 4 +--- contract-inputs/terms-slaslo.md | 11 +++++++++++ contract-inputs/terms-slo.md | 12 ------------ src/SUMMARY.md | 7 +++++-- src/parties.md | 4 ++++ src/services-cloudron-all.md | 2 +- src/services-coolify-randd-lob.md | 2 +- src/services-coolify-techops-all.md | 2 +- src/services-kneldc-all.md | 9 ++++++++- src/services-kneldc-lob.md | 3 ++- src/terms-length.md | 4 +--- src/terms-payment.md | 4 +--- src/terms-slaslo.md | 11 +++++++++++ src/terms-slo.md | 12 ------------ 20 files changed, 89 insertions(+), 46 deletions(-) create mode 100644 CreateDocument.sh rename build-book.sh => RenderBook.sh (100%) create mode 100644 contract-inputs/terms-slaslo.md delete mode 100644 contract-inputs/terms-slo.md delete mode 100644 src/terms-slo.md diff --git a/CreateDocument.sh b/CreateDocument.sh new file mode 100644 index 0000000..155affc --- /dev/null +++ b/CreateDocument.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# Put together the KNEL services contract template + +set -euo pipefail + +# Pull in contract variables +echo "Sourcing contract template variables..." +source ./KNEL-Contract-Template-Variables.env + + +echo "Rendering templates..." +bash RenderTemplates.sh + +echo "Rendering CSV..." +bash RenderCSVToMarkdown.sh + +echo "Putting it all together..." +bash RenderBook.sh \ No newline at end of file diff --git a/KNEL-Contract-Template-Variables.env b/KNEL-Contract-Template-Variables.env index f1b2d05..dc0af2c 100644 --- a/KNEL-Contract-Template-Variables.env +++ b/KNEL-Contract-Template-Variables.env @@ -1,2 +1,14 @@ -export SLA_PENALTY="" -export SLO_PENALTY="" \ No newline at end of file + +export PARTY1="Known Element Enterprises LLC" +export PARTY2="TSYS Group Component" + +export CONTRACT_LENGTH="99 years" + +export PAYMENT_AMOUNT="100.00" +export PAYMENT_FREQUENCY="Monthly" + +export SERVICES_SLA="95%" +export SERVICES_SLO="99%" + +export SLA_PENALTY="none" +export SLO_PENALTY="none" \ No newline at end of file diff --git a/build-book.sh b/RenderBook.sh similarity index 100% rename from build-book.sh rename to RenderBook.sh diff --git a/RenderTemplates.sh b/RenderTemplates.sh index 39e95c6..82dab18 100644 --- a/RenderTemplates.sh +++ b/RenderTemplates.sh @@ -1,9 +1,13 @@ #!/bin/bash -MUSTACHE_PATH="./vendor/" +set -euo pipefail + +source ./KNEL-Contract-Template-Variables.env + +MUSTACHE_PATH="vendor/git.knownelement.com/ExternalVendorCode/mo/mo" 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 + bash $MUSTACHE_PATH $input_file > src/$OUTPUT_FILE_NAME done \ No newline at end of file diff --git a/contract-inputs/parties.md b/contract-inputs/parties.md index 8695add..6c92acb 100644 --- a/contract-inputs/parties.md +++ b/contract-inputs/parties.md @@ -3,4 +3,8 @@ ### Party 1 +{{PARTY1}} + ### Party 2 + +{{PARTY2}} \ No newline at end of file diff --git a/contract-inputs/terms-length.md b/contract-inputs/terms-length.md index 28ee84b..83c4eb9 100644 --- a/contract-inputs/terms-length.md +++ b/contract-inputs/terms-length.md @@ -1,6 +1,4 @@ ## 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 index 3b3f1b4..49bf922 100644 --- a/contract-inputs/terms-payment.md +++ b/contract-inputs/terms-payment.md @@ -1,6 +1,4 @@ ## 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 +- The services are offered for an all inclusive delivered price of {{PAYMENT_AMOUNT}} which must be paid {{PAYMENT_FREQUENCY}} diff --git a/contract-inputs/terms-slaslo.md b/contract-inputs/terms-slaslo.md new file mode 100644 index 0000000..08d71f9 --- /dev/null +++ b/contract-inputs/terms-slaslo.md @@ -0,0 +1,11 @@ +## SLA/SLO + +- The services listed in the section titled "Services Offered by Known Element Enterprises LLC " are provided with the following SLA/SLO: + + - Service Level Agreement (SLA): {{SERVICES_SLA}} + - Service Level Objective (SLO): {{SERVICES_SLO}} + +- Penalities to {{PARTY1}} for not hitting the SLA/SLO + + - Penalty for missing the SLA: {{SLA_PENALTY}} + - Penalty for missing the SLO: {{SLO_PENALTY}} diff --git a/contract-inputs/terms-slo.md b/contract-inputs/terms-slo.md deleted file mode 100644 index fd0b8e0..0000000 --- a/contract-inputs/terms-slo.md +++ /dev/null @@ -1,12 +0,0 @@ -## 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/src/SUMMARY.md b/src/SUMMARY.md index 0f23917..daccf24 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -2,7 +2,7 @@ - [Introduction](./introduction.md) -# Services Offered +# Services Offered by Known Element Enterprises LLC - [Cloudron All TSYS Group](./services-cloudron-all.md) - [Cloudron LOB Bespoke](./services-cloudron-lob.md) @@ -14,8 +14,11 @@ - [KNEL Datacenter LOB Bespoke](./services-kneldc-lob.md) - [General Services](./services-general.md) -# Terms +# Standard legal terms and conditions +# Contract Parties/Terms/Signature + +- [Contract Parties](./parties.md) - [Contract Length](./terms-length.md) - [Payment](./terms-payment.md) - [SLA/SLO](./terms-slaslo.md) diff --git a/src/parties.md b/src/parties.md index 8695add..b4517e0 100644 --- a/src/parties.md +++ b/src/parties.md @@ -3,4 +3,8 @@ ### Party 1 +Known Element Enterprises LLC + ### Party 2 + +TSYS Group Component \ No newline at end of file diff --git a/src/services-cloudron-all.md b/src/services-cloudron-all.md index 736454d..df7d0f4 100644 --- a/src/services-cloudron-all.md +++ b/src/services-cloudron-all.md @@ -28,7 +28,6 @@ |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/)| @@ -47,3 +46,4 @@ |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/)| +|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/)| diff --git a/src/services-coolify-randd-lob.md b/src/services-coolify-randd-lob.md index 2210b3f..911d5c8 100644 --- a/src/services-coolify-randd-lob.md +++ b/src/services-coolify-randd-lob.md @@ -2,4 +2,4 @@ |Function|Vendor|Instance| |---|---|---| -|coming soon|coming soon|coming soon| +|LOB bizapp compute/storage|TBD|TBD| diff --git a/src/services-coolify-techops-all.md b/src/services-coolify-techops-all.md index ff78924..e75aa4a 100644 --- a/src/services-coolify-techops-all.md +++ b/src/services-coolify-techops-all.md @@ -2,4 +2,4 @@ |Function|Vendor|Instance| |---|---|---| -|coming soon|coming soon|coming soon| +|LLC Governance|TBD|TBD| diff --git a/src/services-kneldc-all.md b/src/services-kneldc-all.md index 40058c9..f2b3151 100644 --- a/src/services-kneldc-all.md +++ b/src/services-kneldc-all.md @@ -2,4 +2,11 @@ |Function|Vendor|Instance| |---|---|---| -|coming soon|coming soon|coming soon| +|Soverign Hosting|[Umbrel](https://umbrel.com/)|N/A(KNEL DC VPN no external access) | +|Value4Value|[Helipad](https://tryhelipad.com/)|N/A(KNEL DC VPN no external access) | +|Bitcoin Node|details coming soon|N/A(KNEL DC VPN no external access)| +|Etherum Node|details coming soon|N/A (KNEL DC VPN no external access)| +|Bitcoin Payment Processing|details coming soon|N/A (KNEL DC VPN no external access)| +|NFS/SMB Fileserver|details coming soon|N/A (KNEL DC VPN no external access)| +|VOIP (inbound)|details coming soon|N/A (KNEL DC VPN no external access)| +|Certificate Authority|details coming soon|N/A (KNEL DC VPN no external access)| diff --git a/src/services-kneldc-lob.md b/src/services-kneldc-lob.md index ec0802e..b82a4f0 100644 --- a/src/services-kneldc-lob.md +++ b/src/services-kneldc-lob.md @@ -2,4 +2,5 @@ |Function|Vendor|Instance| |---|---|---| -|coming soon|coming soon|coming soon| +|Storage/Compute/Network HPC Runtime Resources| SLURM| TBD| +|Electronic Design Automation|[EzEDA](https://ezeda.org)| TBD| diff --git a/src/terms-length.md b/src/terms-length.md index 28ee84b..a2ebd15 100644 --- a/src/terms-length.md +++ b/src/terms-length.md @@ -1,6 +1,4 @@ ## 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 +- Contract Length : 99 years \ No newline at end of file diff --git a/src/terms-payment.md b/src/terms-payment.md index 3b3f1b4..c3c467c 100644 --- a/src/terms-payment.md +++ b/src/terms-payment.md @@ -1,6 +1,4 @@ ## 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 +- The services are offered for an all inclusive delivered price of 100.00 which must be paid Monthly diff --git a/src/terms-slaslo.md b/src/terms-slaslo.md index e69de29..ff4f5e3 100644 --- a/src/terms-slaslo.md +++ b/src/terms-slaslo.md @@ -0,0 +1,11 @@ +## SLA/SLO + +- The services listed in the section titled "Services Offered by Known Element Enterprises LLC " are provided with the following SLA/SLO: + + - Service Level Agreement (SLA): 95% + - Service Level Objective (SLO): 99% + +- Penalities to Known Element Enterprises LLC for not hitting the SLA/SLO + + - Penalty for missing the SLA: none + - Penalty for missing the SLO: none diff --git a/src/terms-slo.md b/src/terms-slo.md deleted file mode 100644 index fd0b8e0..0000000 --- a/src/terms-slo.md +++ /dev/null @@ -1,12 +0,0 @@ -## 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}}