Cleanup
Update readme and tryItOut.
This commit is contained in:
parent
b5614681d9
commit
915b97b63f
7 changed files with 63 additions and 141 deletions
147
README.md
147
README.md
|
|
@ -1,134 +1,47 @@
|
|||
# c4k-website README
|
||||
# convention 4 kubernetes: c4k-website
|
||||
[](https://clojars.org/org.domaindrivenarchitecture/c4k-website) [](https://gitlab.com/domaindrivenarchitecture/c4k-website/-/commits/main)
|
||||
|
||||
## Requirements
|
||||
[<img src="https://domaindrivenarchitecture.org/img/delta-chat.svg" width=20 alt="DeltaChat"> chat over e-mail](mailto:buero@meissa-gmbh.de?subject=community-chat) | [<img src="https://meissa-gmbh.de/img/community/Mastodon_Logotype.svg" width=20 alt="team@social.meissa-gmbh.de"> team@social.meissa-gmbh.de](https://social.meissa-gmbh.de/@team) | [Website & Blog](https://domaindrivenarchitecture.org)
|
||||
|
||||
A.C.:
|
||||
wir haben ein konzept erstellt, wie wir statische Inhalte ausliefern (git-pull & cron // cicid // manueller pybuilder-run).
|
||||
## Purpose
|
||||
|
||||
wir haben ein c4k modul, das mehrere statische Websites betreiben kann.
|
||||
-> Neues deployment macht neuen webserver mit neuem FQDN
|
||||
-> Neuer FQDN muss über pyb apply eingetragen werden
|
||||
Delivering cryogen generated static sites with the push of a few buttons.
|
||||
|
||||
c4k holt sich stets die neuesten website-container unterbrechungsfrei.
|
||||
c4k-website generates configuration files for an nginx webserver, and
|
||||
a cryogen static site build container. It automatically downloads a branch.zip from a specified
|
||||
gitea API url. You need an authorization token to access the specified gitea user account.
|
||||
The build container is based on clojure:lein. Webserver and build pods are uniquely named by fqdn, so
|
||||
adding multiple websites shouldn't be a problem.
|
||||
|
||||
Unsere website läuft mit dem neuen Setup, ist unter ipv4/v6 und unter 1 oder 2 FQDNs erreichbar.
|
||||
c4k-website has the following modules:
|
||||
* unique nginx webserver + service + ingress + certificate
|
||||
* unique build container cron job
|
||||
* unique volume claim for both
|
||||
|
||||
## Was passiert?
|
||||
## Try out
|
||||
|
||||
Webserver sollen auf den gleichen, laufenden Cluster hinzugefügt werden können.
|
||||
Click on the image to try out live in your browser:
|
||||
|
||||
**c4k**
|
||||
Pro Website je: Ingress -> Service -> Webserver Pod -> Volume Mount -> PVC.
|
||||
Ingress muss die angefragten FQDNS auflösen und weiterleiten.
|
||||
[](https://domaindrivenarchitecture.org/pages/dda-provision/c4k-website/)
|
||||
|
||||
**Terraform:**
|
||||
Mehrere DNS Einträge auf Terraform Seite für einen Cluster.
|
||||
Your input will stay in your browser. No server interaction is required.
|
||||
|
||||
## Setup
|
||||
|
||||
### Reading:
|
||||
You need:
|
||||
|
||||
https://stackoverflow.com/questions/55243275/implementing-k8s-cluster-for-multiple-websites-with-unique-domain-name
|
||||
* cryogen as a static site generator
|
||||
* a cryogen project ready to build
|
||||
* and a gitea account which holds the buildable project
|
||||
|
||||
https://www.reddit.com/r/kubernetes/comments/j8z7tn/hosting_multiple_static_sites_on_k8s/
|
||||
Before deploying, you need an authorization token, that can be generated in your gitea account.
|
||||
Then you need a URL that points to: `https://your.gitea.host/api/v1/repos/<owner>/<repo>/archive/main.zip`.
|
||||
Add this to your auth.edn config file and you should be ready to go.
|
||||
|
||||
Deploying Nginx:
|
||||
https://kubernetes.io/docs/tasks/run-application/run-stateless-application-deployment/
|
||||
https://www.tecmint.com/deploy-nginx-on-a-kubernetes-cluster/
|
||||
|
||||
##
|
||||
|
||||
Definition von Env-Vars im Deployment:
|
||||
AUTHTOKEN - muss konfigurierbar sein
|
||||
REPOZIPURL - muss konfigurierbar sein
|
||||
WEBSITEROOT - hardcoded, da containerspezifisch
|
||||
|
||||
Certificate, Ingress, Configmap, Deployment, Service, Volume Claim, Website-deployment sollen durch eindeutige, auf FQDN basierenden Namen verbunden sein.
|
||||
|
||||
## Getting started
|
||||
|
||||
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
|
||||
|
||||
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
|
||||
|
||||
## Add your files
|
||||
|
||||
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
|
||||
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
|
||||
|
||||
```
|
||||
cd existing_repo
|
||||
git remote add origin https://gitlab.com/domaindrivenarchitecture/c4k-website.git
|
||||
git branch -M main
|
||||
git push -uf origin main
|
||||
```
|
||||
|
||||
## Integrate with your tools
|
||||
|
||||
- [ ] [Set up project integrations](https://gitlab.com/domaindrivenarchitecture/c4k-website/-/settings/integrations)
|
||||
|
||||
## Collaborate with your team
|
||||
|
||||
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
|
||||
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
|
||||
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
|
||||
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
|
||||
- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
|
||||
## Test and Deploy
|
||||
|
||||
Use the built-in continuous integration in GitLab.
|
||||
|
||||
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
|
||||
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
|
||||
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
|
||||
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
|
||||
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
|
||||
|
||||
***
|
||||
|
||||
# Editing this README
|
||||
|
||||
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
|
||||
|
||||
## Suggestions for a good README
|
||||
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
|
||||
|
||||
## Name
|
||||
Choose a self-explaining name for your project.
|
||||
|
||||
## Description
|
||||
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
|
||||
|
||||
## Badges
|
||||
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
|
||||
|
||||
## Visuals
|
||||
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
|
||||
|
||||
## Installation
|
||||
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
|
||||
|
||||
## Usage
|
||||
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
|
||||
|
||||
## Support
|
||||
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
|
||||
|
||||
## Roadmap
|
||||
If you have ideas for releases in the future, it is a good idea to list them in the README.
|
||||
|
||||
## Contributing
|
||||
State if you are open to contributions and what your requirements are for accepting them.
|
||||
|
||||
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
|
||||
|
||||
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
|
||||
|
||||
## Authors and acknowledgment
|
||||
Show your appreciation to those who have contributed to the project.
|
||||
Let c4k-website generate your .yaml file and `kubectl apply yourApp.yaml`. Done.
|
||||
|
||||
## License
|
||||
For open source projects, say how it is licensed.
|
||||
|
||||
## Project status
|
||||
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
|
||||
Copyright © 2022 meissa GmbH
|
||||
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License")
|
||||
Pls. find licenses of our subcomponents [here](doc/SUBCOMPONENT_LICENSE)
|
||||
|
|
|
|||
BIN
doc/tryItOut.png
BIN
doc/tryItOut.png
Binary file not shown.
|
Before Width: | Height: | Size: 99 KiB After Width: | Height: | Size: 31 KiB |
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
function get-and-unzip-website-data() {
|
||||
filename="website.zip"
|
||||
curl -H "Authorization: token $AUTHTOKEN" -o $SOURCEDIR/$filename $GITREPOURL # GITREPURL = https://your.gitea.host/api/v1/repos/<owner>/<repo>/archive/main.zip
|
||||
curl -H "Authorization: token $AUTHTOKEN" -o $SOURCEDIR/$filename $GITREPOURL
|
||||
unzip $SOURCEDIR/$filename -d $BUILDDIR
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -5,8 +5,7 @@
|
|||
"src/test/cljs"
|
||||
"src/test/resources"]
|
||||
:dependencies [[org.domaindrivenarchitecture/c4k-common-cljs "3.0.1"]
|
||||
[hickory "0.7.1"]
|
||||
[org.clojure/math.numeric-tower "0.0.5"]]
|
||||
[hickory "0.7.1"]]
|
||||
:builds {:frontend {:target :browser
|
||||
:modules {:main {:init-fn dda.c4k-website.browser/init}}
|
||||
:release {}
|
||||
|
|
|
|||
|
|
@ -1,17 +1,30 @@
|
|||
(ns dda.c4k-website.core
|
||||
(:require
|
||||
[clojure.spec.alpha :as s]
|
||||
[dda.c4k-common.yaml :as yaml]
|
||||
[dda.c4k-common.common :as cm]
|
||||
[dda.c4k-website.website :as website]))
|
||||
|
||||
(def config-defaults {:issuer "staging"})
|
||||
|
||||
(def config? (s/keys :req-un [::website/fqdn]
|
||||
:opt-un [::website/issuer]))
|
||||
|
||||
(def auth? (s/keys :req-un [::website/authtoken
|
||||
::website/gitrepourl]))
|
||||
|
||||
(def vol? (s/keys :req-un [::website/volume-total-storage-size
|
||||
::website/number-of-websites]))
|
||||
|
||||
(defn k8s-objects [config]
|
||||
(cm/concat-vec
|
||||
(map yaml/to-string
|
||||
[(website/generate-nginx-deployment config)
|
||||
(website/generate-nginx-configmap config)
|
||||
(website/generate-nginx-service config)
|
||||
(website/generate-website-content-volume config)
|
||||
(website/generate-ingress config)
|
||||
(website/generate-certificate config)
|
||||
(website/generate-website-build-cron config)
|
||||
(website/generate-website-build-secret config)])))
|
||||
(cm/concat-vec
|
||||
(map yaml/to-string
|
||||
(filter #(not (nil? %))
|
||||
[(website/generate-nginx-deployment config)
|
||||
(website/generate-nginx-configmap config)
|
||||
(website/generate-nginx-service config)
|
||||
(website/generate-website-content-volume config)
|
||||
(website/generate-ingress config)
|
||||
(website/generate-certificate config)
|
||||
(website/generate-website-build-cron config)
|
||||
(website/generate-website-build-secret config)]))))
|
||||
|
|
|
|||
|
|
@ -14,15 +14,12 @@
|
|||
[dda.c4k-common.base64 :as b64]
|
||||
[dda.c4k-common.predicate :as pred]))
|
||||
|
||||
(defn domain-list?
|
||||
[input]
|
||||
(or
|
||||
(st/blank? input)
|
||||
(pred/string-of-separated-by? pred/fqdn-string? #"," input)))
|
||||
|
||||
(s/def ::fqdn pred/fqdn-string?)
|
||||
(s/def ::issuer pred/letsencrypt-issuer?)
|
||||
(s/def ::volume-total-storage-size (partial pred/int-gt-n? 5))
|
||||
(s/def ::volume-total-storage-size int?)
|
||||
(s/def ::number-of-websites int?)
|
||||
(s/def ::authtoken pred/bash-env-string?)
|
||||
(s/def ::gitrepourl pred/bash-env-string?)
|
||||
|
||||
(def config-defaults {:issuer "staging"})
|
||||
|
||||
|
|
|
|||
|
|
@ -65,7 +65,7 @@
|
|||
{:issuer issuer})
|
||||
)))
|
||||
|
||||
(defn validate-all! [] ; ToDo: Add all necessary inputs and auth
|
||||
(defn validate-all! []
|
||||
(br/validate! "fqdn" ::website/fqdn)
|
||||
(br/validate! "issuer" ::website/issuer :optional true)
|
||||
(br/validate! "volume-total-storage-size" ::website/volume-total-storage-size :deserializer js/parseInt)
|
||||
|
|
@ -89,7 +89,7 @@
|
|||
(br/get-content-from-element "auth" :deserializer edn/read-string)
|
||||
website/config-defaults
|
||||
core/k8s-objects)
|
||||
(br/set-output!)))))
|
||||
(br/set-output!)))))
|
||||
(add-validate-listener "fqdn")
|
||||
(add-validate-listener "volume-total-storage-size")
|
||||
(add-validate-listener "issuer")
|
||||
|
|
|
|||
Loading…
Reference in a new issue
