Skip to content

Commit

Permalink
docs(README.md): added timings for Apply and Destroy
Browse files Browse the repository at this point in the history
  • Loading branch information
morga471 committed Aug 6, 2024
1 parent bb2f7b1 commit ecec0b0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 53 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,14 @@
- **repo**: add pre-commit and commitizen repo features

## 1.0.1 (2023-11-01)

# CHANGELOG
* 1.0.3 -- 2024-07-30
- updated image module
- bumped version
* 1.0.2 -- 2024-07-22
- updated istio chart/app to 1.22.3
- add force_delete and lifecycle policies to copy_images
- updated version.tf to 1.0.2
- included module.images in depends on helm charts
- created changelog
66 changes: 13 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,65 +21,25 @@ have a istio proxy configured, prevent communication with that pod.)
configuration of which identities are allowed to call services, and
which services are allowed to interact with other services.

# CHANGELOG
* 1.0.3 -- 2024-07-30
- updated image module
- bumped version
* 1.0.2 -- 2024-07-22
- updated istio chart/app to 1.22.3
- add force_delete and lifecycle policies to copy_images
- updated version.tf to 1.0.2
- included module.images in depends on helm charts
- created changelog

## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.14.0 |
| <a name="requirement_helm"></a> [helm](#requirement\_helm) | >= 2.11.0 |
| <a name="requirement_kubernetes"></a> [kubernetes](#requirement\_kubernetes) | >= 2.23.0 |
| <a name="requirement_null"></a> [null](#requirement\_null) | >= 3.2.1 |

## Inputs

| Name | Description | Type | Default | Required |
|------|-------------|------|---------|:--------:|
| <a name="input_cluster_name"></a> [cluster\_name](#input\_cluster\_name) | The name of the cluster into which istio will be installed. | `string` | n/a | yes |
| <a name="input_enable_egress_gateway"></a> [enable\_egress\_gateway](#input\_enable\_egress\_gateway) | Enable Istio to control outbound traffic from the cluster. | `bool` | `true` | no |
| <a name="input_enable_telemetry"></a> [enable\_telemetry](#input\_enable\_telemetry) | Enable Istio's stracing, monitoring, and logging features. | `string` | `"true"` | no |
| <a name="input_extra_listener_ports"></a> [extra\_listener\_ports](#input\_extra\_listener\_ports) | A list of additional ports that the ingress load balancer should listen to, 9094 for kafka as an example. | <pre>list(object({<br> name = string<br> port = string<br> }))</pre> | `[]` | no |
| <a name="input_istio_chart_version"></a> [istio\_chart\_version](#input\_istio\_chart\_version) | The version of istio to install into the cluster. | `string` | `"1.18.2"` | no |
| <a name="input_istio_version"></a> [istio\_version](#input\_istio\_version) | The version of istio to install into the cluster. | `string` | `"1.18.2"` | no |
| <a name="input_namespace"></a> [namespace](#input\_namespace) | The namespace to install the istio components. Defaults to 'istio-system' | `string` | `"istio-system"` | no |
| <a name="input_profile"></a> [profile](#input\_profile) | AWS\_PROFILE to use to apply the terraform script. | `string` | `""` | no |
| <a name="input_region"></a> [region](#input\_region) | The region in which the cluster is running. | `string` | n/a | yes |
| <a name="input_tags"></a> [tags](#input\_tags) | Tags to be added to the load balancer in AWS. | `map(string)` | `{}` | no |
A successful Apply will yield:
Apply complete! Resources: 11 added, 0 changed, 0 destroyed.

## Outputs
Outputs:

| Name | Description |
|------|-------------|
| <a name="output_module_name"></a> [module\_name](#output\_module\_name) | The name of this module. |
| <a name="output_module_version"></a> [module\_version](#output\_module\_version) | The version of this module. |
module_name = "tfmod-istio"
module_version = "1.0.3"

## Resources
real 1m24.584s
user 0m40.156s
sys 0m5.320s

| Name | Type |
|------|------|
| [helm_release.base](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
| [helm_release.egress](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
| [helm_release.ingress](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
| [helm_release.istiod](https://registry.terraform.io/providers/hashicorp/helm/latest/docs/resources/release) | resource |
| [kubernetes_namespace.ns](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/resources/namespace) | resource |
| [kubernetes_service.apiserver](https://registry.terraform.io/providers/hashicorp/kubernetes/latest/docs/data-sources/service) | data source |
A successful Destroy will yield:
Destroy complete! Resources: 11 destroyed.

## Modules

| Name | Source | Version |
|------|--------|---------|
| <a name="module_images"></a> [images](#module\_images) | git@github.e.it.census.gov:terraform-modules/aws-ecr-copy-images.git/ | 2.0.2 |
real 0m47.952s
user 0m25.809s
sys 0m2.991s

<!-- BEGIN_TF_DOCS -->
# tfmod-istio
Expand Down

0 comments on commit ecec0b0

Please sign in to comment.