You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/aws-cloud-provider.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Deploying to AWS
2
2
3
-
cdev uses project templates to generate projects in a desired cloud. This section describes steps necessary to start working with cdev in AWS cloud using [AWS-EKS](https://github.com/shalb/cdev-aws-eks) template.
3
+
cdev uses stack templates to generate projects in a desired cloud. This section describes steps necessary to start working with cdev in AWS cloud using [AWS-EKS](https://github.com/shalb/cdev-aws-eks) stack template.
4
4
5
-
## Prerequisites to use AWS-EKS template
5
+
## Prerequisites to use AWS-EKS stack template
6
6
7
7
1. Terraform version 13+.
8
8
@@ -73,7 +73,7 @@ aws s3 mb s3://cdev-states
73
73
74
74
### DNS Zone
75
75
76
-
For the AWS-EKS template example, you need to define a Route 53 hosted zone. Options:
76
+
In AWS-EKS stack template example you need to define a Route 53 hosted zone. Options:
77
77
78
78
1. You already have a Route 53 hosted zone.
79
79
@@ -83,7 +83,7 @@ For the AWS-EKS template example, you need to define a Route 53 hosted zone. Opt
83
83
84
84
## AWS-EKS
85
85
86
-
[AWS-EKS](https://github.com/shalb/cdev-aws-eks) is a cdev template that creates and provisions Kubernetes clusters in AWS cloud by means of Amazon Elastic Kubernetes Service (EKS).
86
+
[AWS-EKS](https://github.com/shalb/cdev-aws-eks) is a cdev stack template that creates and provisions Kubernetes clusters in AWS cloud by means of Amazon Elastic Kubernetes Service (EKS).
87
87
88
88
### AWS-EKS starting guide
89
89
@@ -96,7 +96,7 @@ For the AWS-EKS template example, you need to define a Route 53 hosted zone. Opt
96
96
```
97
97
98
98
!!! tip
99
-
The template's repo could contain several options for project generation. To list available generators, use ```--list-templates``` option:
99
+
The stack template's repo could contain several options for project generation. To list available generators, use ```--list-templates``` option:
@@ -120,7 +120,7 @@ For the AWS-EKS template example, you need to define a Route 53 hosted zone. Opt
120
120
121
121
* backend.yaml - configures backend for cdev states (including Terraform states). Uses variables from project.yaml. See [backend docs](https://cluster.dev/project-configuration/#backends).
122
122
123
-
* infra.yaml - describes infrastructure configuration. See [infrastructure docs](https://cluster.dev/project-configuration/#infrastructure).
123
+
* infra.yaml - describes stack configuration. See [infrastructure docs](https://cluster.dev/project-configuration/#infrastructure).
124
124
125
125
4. Run `cdev plan` to build the project. In the output you will see an infrastructure that is going to be created after running `cdev apply`.
126
126
@@ -132,7 +132,7 @@ For the AWS-EKS template example, you need to define a Route 53 hosted zone. Opt
132
132
!!! tip
133
133
We highly recommend to run `cdev apply` in a debug mode so that you could see cdev logging in the output: `cdev apply -l debug`
134
134
135
-
6. After `cdev apply` is successfully executed, in the output you will see the ArgoCD URL of your cluster. Sign in to the console to check whether ArgoCD is up and running and the template has been deployed correctly. To sign in, use the "admin" login and the bcrypted password that you have generated for the infra.yaml.
135
+
6. After `cdev apply` is successfully executed, in the output you will see the ArgoCD URL of your cluster. Sign in to the console to check whether ArgoCD is up and running and the stack template has been deployed correctly. To sign in, use the "admin" login and the bcrypted password that you have generated for the infra.yaml.
136
136
137
137
7. Displayed in the output will be also a command on how to get kubeconfig and connect to your Kubernetes cluster.
Copy file name to clipboardExpand all lines: docs/cli-commands.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,22 +2,22 @@
2
2
3
3
Available commands:
4
4
5
-
*`apply` Apply all modules - build project (see build command), calculate dependencies, create and check graph. Deploy all modules according to the graph.
5
+
*`apply` Apply all units - build project (see build command), calculate dependencies, create and check graph. Deploy all units according to the graph.
6
6
7
-
*`build` Build all modules - read project configuration. Check it, render templates and generate code of all modules in tmp dir: `./cluster.dev/project-name/`.
7
+
*`build` Build all units - read project configuration. Check it, render stack templates and generate code of all units in tmp dir: `./cluster.dev/project-name/`.
8
8
9
-
*`destroy` Destroy all modules - build project (see build command), calculate dependencies, create and check the reverse graph. Run destroy scenario for all modules according to the graph.
9
+
*`destroy` Destroy all units - build project (see build command), calculate dependencies, create and check the reverse graph. Run destroy scenario for all units according to the graph.
10
10
11
11
*`help` Help about any command.
12
12
13
13
*`output` Display the template's output.
14
14
15
-
*`plan` Plan all modules - build project. Try to run the plan scenario for modules. Modules often refer to the remote states of other modules. Because of this, the plan command may fail if the remote state does not already exist.
15
+
*`plan` Plan all units - build project. Try to run the plan scenario for units. Units often refer to the remote states of other units. Because of this, the plan command may fail if the remote state does not already exist.
16
16
17
17
*`project` Manage projects:
18
18
19
19
*`info` Read project and info message.
20
-
*`create`Creates new 'project' from template in an interactive mode.
20
+
*`create`Create new 'project' from a stack template in an interactive mode.
Copy file name to clipboardExpand all lines: docs/digital-ocean-cloud-provider.md
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Deploying to DigitalOcean
2
2
3
-
cdev uses project templates to generate projects in a desired cloud. This section describes steps necessary to start working with cdev in DigitalOcean cloud using [DO-k8s](https://github.com/shalb/cdev-do-k8s) template.
3
+
cdev uses stack templates to generate projects in a desired cloud. This section describes steps necessary to start working with cdev in DigitalOcean cloud using [DO-k8s](https://github.com/shalb/cdev-do-k8s) stack template.
4
4
5
-
## Prerequisites to use DO-k8s template
5
+
## Prerequisites to use DO-k8s stack template
6
6
7
7
1. Terraform version 13+.
8
8
@@ -54,7 +54,7 @@ For details on using DO spaces bucket as a backend, see [here](https://www.digit
54
54
55
55
## DO-k8s
56
56
57
-
[DO-k8s](https://github.com/shalb/cdev-do-k8s) is a cdev template that creates and provisions Kubernetes clusters in the DigitalOcean cloud.
57
+
[DO-k8s](https://github.com/shalb/cdev-do-k8s) is a cdev stack template that creates and provisions Kubernetes clusters in the DigitalOcean cloud.
58
58
59
59
### DO-k8s starting guide
60
60
@@ -67,7 +67,7 @@ For details on using DO spaces bucket as a backend, see [here](https://www.digit
67
67
```
68
68
69
69
!!! tip
70
-
The template's repo could contain several options for project generation. To list available generators, use ```--list-templates``` option:
70
+
The stack template's repo could contain several options for project generation. To list available generators, use ```--list-templates``` option:
@@ -91,7 +91,7 @@ For details on using DO spaces bucket as a backend, see [here](https://www.digit
91
91
92
92
* backend.yaml - configures backend for cdev states (including Terraform states). Uses variables from project.yaml. See [backend docs](https://cluster.dev/project-configuration/#backends).
93
93
94
-
* infra.yaml - describes infrastructure configuration. See [infrastructure docs](https://cluster.dev/project-configuration/#infrastructure).
94
+
* infra.yaml - describes stack configuration. See [infrastructure docs](https://cluster.dev/project-configuration/#infrastructure).
95
95
96
96
4. Run `cdev plan` to build the project. In the output you will see an infrastructure that is going to be created after running `cdev apply`.
97
97
@@ -103,7 +103,7 @@ For details on using DO spaces bucket as a backend, see [here](https://www.digit
103
103
!!! tip
104
104
We highly recommend to run `cdev apply` in a debug mode so that you could see cdev logging in the output: `cdev apply -l debug`
105
105
106
-
6. After `cdev apply` is successfully executed, in the output you will see the ArgoCD URL of your cluster. Sign in to the console to check whether ArgoCD is up and running and the template has been deployed correctly. To sign in, use the "admin" login and the bcrypted password that you have generated for the infra.yaml.
106
+
6. After `cdev apply` is successfully executed, in the output you will see the ArgoCD URL of your cluster. Sign in to the console to check whether ArgoCD is up and running and the stack template has been deployed correctly. To sign in, use the "admin" login and the bcrypted password that you have generated for the infra.yaml.
107
107
108
108
7. Displayed in the output will be also a command on how to get kubeconfig and connect to your Kubernetes cluster.
Copy file name to clipboardExpand all lines: docs/documentation-structure.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,22 @@ This page explains how the cdev documentation is organized, and is aimed to help
5
5
!!! info
6
6
Please note that cdev documentation is intended for two groups of users and is divided respectively.
7
7
8
-
***Infrastructure users** - engineers who want to create infrastructures from ready-made templates. No Terraform or Helm knowledge required. Just choose a template, fill in required variables and have your infrastructure running. We provide you with ready-made templates, and metadata dialogs generators.
8
+
***Stack users** - engineers who want to create infrastructures from ready-made stack templates. No Terraform or Helm knowledge required. Just choose a stack template, fill in required variables and have your infrastructure running. We provide you with ready-made stack templates, and metadata dialogs generators.
9
9
10
-
***Infrastructure developers** - engineers who want to create infrastructure templates of their own, using existing blocks (Terraform modules, Helm charts, k8s manifests) so that other users could create infrastructures based on them. This approach requires strong skills and working experience with Terraform modules and Helm charts development.
10
+
***Stack developers** - engineers who want to create stack templates of their own, using existing blocks (Terraform modules, Helm charts, k8s manifests) so that other users could create infrastructures based on them. This approach requires strong skills and working experience with Terraform modules and Helm charts development.
11
11
12
12
## Website structure
13
13
14
14
***Home** - introductory section that gives basic knowledge about cdev.
15
15
16
-
***Getting Started** - contains the list of preliminary conditions needed to start working with cdev, steps on configuring cloud access, and guides on creating projects with cdev templates.
16
+
***Getting Started** - contains the list of preliminary conditions needed to start working with cdev, steps on configuring cloud access, and guides on creating projects with cdev stack templates.
17
17
18
18
!!! info
19
-
Is intended for infrastructure users.
19
+
Is intended for stack users.
20
20
21
-
***Template Development** - contains description of template blocks, such as functions and modules, and information on creating infrastructure templates (to be added soon).
21
+
***Stack Template Development** - contains description of stack template blocks, such as functions and units, and information on creating stack templates (to be added soon).
22
22
23
23
!!! info
24
-
Is intended for infrastructure developers.
24
+
Is intended for stack developers.
25
25
26
-
***Reference** - contains description of project objects, and supplemental information that could be useful both for infrastructure users and developers.
26
+
***Reference** - contains description of project objects, and supplemental information that could be useful both for the stack users and developers.
Copy file name to clipboardExpand all lines: docs/index.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,9 +2,9 @@
2
2
3
3
## What is it?
4
4
5
-
Cluster.dev is an open-source tool designed to manage Cloud Native Infrastructures with simple declarative manifests - infrastructure templates. It allows you to describe a whole infrastructure and deploy it with a single tool.
5
+
Cluster.dev is an open-source tool designed to manage cloud native infrastructures with simple declarative manifests - stack templates. It allows you to describe a whole infrastructure and deploy it with a single tool.
6
6
7
-
The infrastructure templates could be based on Terraform modules, Kubernetes manifests, Shell scripts, Helm charts, Kustomize and ArgoCD/Flux applications, OPA policies etc. Cluster.dev sticks those components together so that you could deploy, test and distribute a whole set of components with pinned versions.
7
+
The stack templates could be based on Terraform modules, Kubernetes manifests, Shell scripts, Helm charts, Kustomize and ArgoCD/Flux applications, OPA policies etc. Cluster.dev sticks those components together so that you could deploy, test and distribute a whole set of components with pinned versions.
8
8
9
9
## Principle Diagram
10
10
@@ -16,7 +16,7 @@ The infrastructure templates could be based on Terraform modules, Kubernetes man
16
16
17
17
## How does it work?
18
18
19
-
With cluster.dev you create or download a predefined template, set the variables, then render and deploy a whole infra set.
19
+
With cluster.dev you create or download a predefined stack template, set the variables, then render and deploy a whole stack.
0 commit comments