pi-ux-ce/Terraform_kube
1
0
Fork 0
Code Issues 10 Pull Requests Actions Packages Projects Releases Wiki Activity

documentation in progress

Browse Source
This commit is contained in:
pi-ux-ce
2024-12-11 23:00:31 +00:00
parent 89e8f53564
commit ca4c403b25
1 changed files with 64 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+64 -49
View File
@@ -1,44 +1,59 @@
# Terraform deploy # Terraform deploy
## Variable ## variables
- name ### name
Define the name
***optional*** ***optional***
(string) (string)
- image = string ### image = string
- pvc = optional(map(object({ Define the image tag
- name = string
- pvc = optional(bool, false)
- config_map = optional(bool, false) ### pvc =
- host_path = optional(string) ***optional***
- pvc_size = optional(string) specifiy the pvc details
- mount_path = string #### name = string
- environment = optional(map(object({ Name of the PVC
- name = optional(string)
- value = optional(string) #### pvc = optional(bool, false)
- value_from = optional(object({ ***PVC - Hostpath - Configmap shouldn't be specifiy at the same time***
- secret_key_ref = object({ Boolean to specify if it is a PVC
- name = string [Example](https://gitea.tryton.geeraert.eu/pi-ux-ce/Terraform_kube#volume-as-pvc)
- key = optional(string, null) #### config_map = optional(bool, false)
- replicas = optional(number, 1) Boolean to specify if it is a configmap
- namespace = optional(string) [Example](https://gitea.tryton.geeraert.eu/pi-ux-ce/Terraform_kube#volume-as-configmap)
- service_port = optional(number) #### host_path = optional(string)
- service_name = optional(string) Boolean to specify if it is a hostpath
- liveness_tcp_socket = optional(number) [Example](https://gitea.tryton.geeraert.eu/pi-ux-ce/Terraform_kube#volume-as-hostpath)
- liveness_http_get = optional(string) #### pvc_size = optional(string)
- liveness_http_get_path = optional(string) #### mount_path = string
- database = optional(map(string)) ### environment = optional(map(object({
- redis = optional(map(string)) ### name = optional(string)
- enabled = optional(bool, true) ### value = optional(string)
- secret_ref = optional(list(string)) ### value_from = optional(object({
- config_map_ref = optional(list(string)) ### secret_key_ref = object({
- requirements = optional(map(string), { ### name = string
- limits-cpu = "800m" ### key = optional(string, null)
- limits-memory = "500Mi" ### replicas = optional(number, 1)
- requests-cpu = "200m" ### namespace = optional(string)
- requests-memory = "200Mi" ### service_port = optional(number)
- environment_variables = optional(map(string), { name = "value" }) ### service_name = optional(string)
### liveness_tcp_socket = optional(number)
### liveness_http_get = optional(string)
### liveness_http_get_path = optional(string)
### database = optional(map(string))
### redis = optional(map(string))
### enabled = optional(bool, true)
### secret_ref = optional(list(string))
### config_map_ref = optional(list(string))
### requirements = optional(map(string), {
### limits-cpu = "800m"
### limits-memory = "500Mi"
### requests-cpu = "200m"
### requests-memory = "200Mi"
### environment_variables = optional(map(string), { name = "value" })
not in use anymore not in use anymore
### Name ### Name
@@ -101,8 +116,8 @@ Already a pro? Just edit this README.md and make it your own. Want to make it ea
## Add your files ## 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 ### [ ] [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: ### [ ] [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 cd existing_repo
@@ -113,31 +128,31 @@ git push -uf origin main
## Integrate with your tools ## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.tryton.geeraert.eu/pierre/bitwarden_kube/-/settings/integrations) ### [ ] [Set up project integrations](https://gitlab.tryton.geeraert.eu/pierre/bitwarden_kube/-/settings/integrations)
## Collaborate with your team ## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/) ### [ ] [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) ### [ ] [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) ### [ ] [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/) ### [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html) ### [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy ## Test and Deploy
Use the built-in continuous integration in GitLab. Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html) ### [ ] [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/) ### [ ] [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) ### [ ] [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/) ### [ ] [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) ### [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
--- ---
# Editing this README # 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!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template. 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!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README ## Suggestions for a good README