Skip to content

Commit e059fe8

Browse files
authored
Merge pull request #142 from shalb/shell-module
Renaming
2 parents 0998e43 + f6c259e commit e059fe8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1902
-871
lines changed

cmd/cdev/includes.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ import (
66
_ "github.com/shalb/cluster.dev/pkg/backend/gcs"
77
_ "github.com/shalb/cluster.dev/pkg/backend/s3"
88
_ "github.com/shalb/cluster.dev/pkg/logging"
9+
_ "github.com/shalb/cluster.dev/pkg/modules/shell/common"
10+
_ "github.com/shalb/cluster.dev/pkg/modules/shell/kubectl"
911
_ "github.com/shalb/cluster.dev/pkg/modules/terraform/helm"
1012
_ "github.com/shalb/cluster.dev/pkg/modules/terraform/kubernetes"
1113
_ "github.com/shalb/cluster.dev/pkg/modules/terraform/printer"

docs/aws-cloud-provider.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Deploying to AWS
22

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.
44

5-
## Prerequisites to use AWS-EKS template
5+
## Prerequisites to use AWS-EKS stack template
66

77
1. Terraform version 13+.
88

@@ -73,7 +73,7 @@ aws s3 mb s3://cdev-states
7373

7474
### DNS Zone
7575

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:
7777

7878
1. You already have a Route 53 hosted zone.
7979

@@ -83,7 +83,7 @@ For the AWS-EKS template example, you need to define a Route 53 hosted zone. Opt
8383

8484
## AWS-EKS
8585

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).
8787

8888
### AWS-EKS starting guide
8989

@@ -96,7 +96,7 @@ For the AWS-EKS template example, you need to define a Route 53 hosted zone. Opt
9696
```
9797

9898
!!! 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:
100100
101101
```bash
102102
cdev project create https://github.com/shalb/cdev-aws-eks --list-templates
@@ -120,7 +120,7 @@ For the AWS-EKS template example, you need to define a Route 53 hosted zone. Opt
120120

121121
* backend.yaml - configures backend for cdev states (including Terraform states). Uses variables from project.yaml. See [backend docs](https://cluster.dev/project-configuration/#backends).
122122

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).
124124

125125
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`.
126126

@@ -132,7 +132,7 @@ For the AWS-EKS template example, you need to define a Route 53 hosted zone. Opt
132132
!!! tip
133133
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`
134134
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.
136136
137137
7. Displayed in the output will be also a command on how to get kubeconfig and connect to your Kubernetes cluster.
138138

docs/cli-commands.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,22 @@
22

33
Available commands:
44

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.
66

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/`.
88

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.
1010

1111
* `help` Help about any command.
1212

1313
* `output` Display the template's output.
1414

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.
1616

1717
* `project` Manage projects:
1818

1919
* `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.
2121

2222
* `secret` Manage secrets:
2323

docs/cli-options.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
* `--interactive` Use interactive mode for project generation.
2424

25-
* `--list-templates` Show all available templates for project generator.
25+
* `--list-templates` Show all available stack templates for project generator.
2626

2727
## Destroy flags
2828

docs/digital-ocean-cloud-provider.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Deploying to DigitalOcean
22

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.
44

5-
## Prerequisites to use DO-k8s template
5+
## Prerequisites to use DO-k8s stack template
66

77
1. Terraform version 13+.
88

@@ -54,7 +54,7 @@ For details on using DO spaces bucket as a backend, see [here](https://www.digit
5454

5555
## DO-k8s
5656

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.
5858

5959
### DO-k8s starting guide
6060

@@ -67,7 +67,7 @@ For details on using DO spaces bucket as a backend, see [here](https://www.digit
6767
```
6868

6969
!!! 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:
7171
7272
```bash
7373
cdev project create https://github.com/shalb/cdev-do-k8s --list-templates
@@ -91,7 +91,7 @@ For details on using DO spaces bucket as a backend, see [here](https://www.digit
9191

9292
* backend.yaml - configures backend for cdev states (including Terraform states). Uses variables from project.yaml. See [backend docs](https://cluster.dev/project-configuration/#backends).
9393

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).
9595

9696
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`.
9797

@@ -103,7 +103,7 @@ For details on using DO spaces bucket as a backend, see [here](https://www.digit
103103
!!! tip
104104
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`
105105
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.
107107
108108
7. Displayed in the output will be also a command on how to get kubeconfig and connect to your Kubernetes cluster.
109109

docs/documentation-structure.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,22 @@ This page explains how the cdev documentation is organized, and is aimed to help
55
!!! info
66
Please note that cdev documentation is intended for two groups of users and is divided respectively.
77

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.
99

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.
1111

1212
## Website structure
1313

1414
* **Home** - introductory section that gives basic knowledge about cdev.
1515

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.
1717

1818
!!! info
19-
Is intended for infrastructure users.
19+
Is intended for stack users.
2020

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).
2222

2323
!!! info
24-
Is intended for infrastructure developers.
24+
Is intended for stack developers.
2525

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.

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,9 @@
22

33
## What is it?
44

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.
66

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.
88

99
## Principle Diagram
1010

@@ -16,7 +16,7 @@ The infrastructure templates could be based on Terraform modules, Kubernetes man
1616

1717
## How does it work?
1818

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.
2020

2121
Capabilities:
2222

0 commit comments

Comments
 (0)