documentation in progress
This commit is contained in:
@@ -1,44 +1,59 @@
|
||||
# Terraform deploy
|
||||
|
||||
## Variable
|
||||
## variables
|
||||
|
||||
- name
|
||||
### name
|
||||
Define the name
|
||||
***optional***
|
||||
(string)
|
||||
|
||||
- image = string
|
||||
- pvc = optional(map(object({
|
||||
- name = string
|
||||
- pvc = optional(bool, false)
|
||||
- config_map = optional(bool, false)
|
||||
- host_path = optional(string)
|
||||
- pvc_size = optional(string)
|
||||
- mount_path = string
|
||||
- environment = optional(map(object({
|
||||
- name = optional(string)
|
||||
- value = optional(string)
|
||||
- value_from = optional(object({
|
||||
- secret_key_ref = object({
|
||||
- name = string
|
||||
- key = optional(string, null)
|
||||
- replicas = optional(number, 1)
|
||||
- namespace = optional(string)
|
||||
- service_port = optional(number)
|
||||
- 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" })
|
||||
### image = string
|
||||
Define the image tag
|
||||
|
||||
|
||||
### pvc =
|
||||
***optional***
|
||||
specifiy the pvc details
|
||||
#### name = string
|
||||
Name of the PVC
|
||||
|
||||
#### pvc = optional(bool, false)
|
||||
***PVC - Hostpath - Configmap shouldn't be specifiy at the same time***
|
||||
Boolean to specify if it is a PVC
|
||||
[Example](https://gitea.tryton.geeraert.eu/pi-ux-ce/Terraform_kube#volume-as-pvc)
|
||||
#### config_map = optional(bool, false)
|
||||
Boolean to specify if it is a configmap
|
||||
[Example](https://gitea.tryton.geeraert.eu/pi-ux-ce/Terraform_kube#volume-as-configmap)
|
||||
#### host_path = optional(string)
|
||||
Boolean to specify if it is a hostpath
|
||||
[Example](https://gitea.tryton.geeraert.eu/pi-ux-ce/Terraform_kube#volume-as-hostpath)
|
||||
#### pvc_size = optional(string)
|
||||
#### mount_path = string
|
||||
### environment = optional(map(object({
|
||||
### name = optional(string)
|
||||
### value = optional(string)
|
||||
### value_from = optional(object({
|
||||
### secret_key_ref = object({
|
||||
### name = string
|
||||
### key = optional(string, null)
|
||||
### replicas = optional(number, 1)
|
||||
### namespace = optional(string)
|
||||
### service_port = optional(number)
|
||||
### 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
|
||||
|
||||
### 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
|
||||
|
||||
- [ ] [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:
|
||||
### [ ] [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
|
||||
@@ -113,31 +128,31 @@ git push -uf origin main
|
||||
|
||||
## 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
|
||||
|
||||
- [ ] [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/)
|
||||
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
|
||||
### [ ] [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/)
|
||||
### [ ] [Set auto-merge](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)
|
||||
### [ ] [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!). 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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user