Skip to content

Commit

Permalink
Adjust documentation to reflect the deletion of the multi-stage.
Browse files Browse the repository at this point in the history
  • Loading branch information
lemaitre-aneo committed Mar 13, 2024
1 parent 88b2f22 commit 984de35
Show file tree
Hide file tree
Showing 12 changed files with 39 additions and 1,083 deletions.
14 changes: 9 additions & 5 deletions .docs/content/0.armonik/0.index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,13 @@ ArmoniK should be used when the following criteria are met:

## Versions

The current version of ArmoniK uses the tags listed in [armonik-versions.txt](https://github.com/aneoconsulting/ArmoniK/blob/main/armonik-versions.txt) where:
The current version of ArmoniK uses the tags listed in [versions.tfvars.json](https://github.com/aneoconsulting/ArmoniK/blob/main/versions.tfvars.json) where:

- `core` is the ArmoniK Core tag used for container images of Control plane, Polling agent and Metrics exporter.
- `worker` is the tag used for the container image of the workers
- `admin-gui` is the tag used for the container images of ArmoniK AdminGUI (admin-api and admin-app)
- `samples` is the tag for ArmoniK Samples

- `armonik` is the tag of the main repository of [ArmoniK](https://github.com/aneoconsulting/ArmoniK)
- `infra` is the tag of [ArmoniK.Infra](https://github.com/aneoconsulting/ArmoniK.Infra) repository which host the infrastructure modules
- `core` is the tag of [ArmoniK.Core](https://github.com/aneoconsulting/ArmoniK.Core) repository used for container images of Control plane, Polling agent and Metrics exporter
- `api` is the tag of [ArmoniK.Api](https://github.com/aneoconsulting/ArmoniK.Api) repository (informative only)
- `gui` is the tag of [ArmoniK.Admin.GUI](https://github.com/aneoconsulting/ArmoniK.Admin.GUI) repository used for container images of ArmoniK AdminGUI
- `extcsharp` is the tag of [ArmoniK.Extensions.Csharp](https://github.com/aneoconsulting/ArmoniK.Extensions.Csharp) repository used for container images of the DLL worker
- `samples` is the tag of [ArmoniK.Samples](https://github.com/aneoconsulting/ArmoniK.Samples) repository
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ This deployment is for development purposes.

## Deploy

To launch the deployment, go to the [`infrastructure/quick-deploy/localhost/all-in-one`](https://github.com/aneoconsulting/ArmoniK/tree/main/infrastructure/quick-deploy/localhost/all-in-one) directory:
To launch the deployment, go to the [`infrastructure/quick-deploy/localhost`](https://github.com/aneoconsulting/ArmoniK/tree/main/infrastructure/quick-deploy/localhost) directory:

If you want to deploy on AWS, go to the dedicated section on [`AWS`](https://github.com/aneoconsulting/ArmoniK/tree/main/infrastructure/quick-deploy/aws/all-in-one)
If you want to deploy on AWS, go to the dedicated section on [`AWS`](https://github.com/aneoconsulting/ArmoniK/tree/main/infrastructure/quick-deploy/aws)

Execute the following command:

Expand All @@ -26,10 +26,10 @@ make deploy

## Configuration

All parameters are contained in [`parameters.tfvars`](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/localhost/all/parameters.tfvars)
All parameters are contained in [`parameters.tfvars`](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/localhost/parameters.tfvars)

::alert{type="info"}
By default, all the cloud services are set to launch. To see what kind of parameters are available, read [`variables.tf`](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/localhost/all/variables.tf)
By default, all the cloud services are set to launch. To see what kind of parameters are available, read [`variables.tf`](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/localhost/variables.tf)
::

You can specify a custom parameter file. When executing the `make` command, you may use the `PARAMETERS_FILE` option to set the path to your file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ git clone https://github.com/aneoconsulting/ArmoniK.Samples.git ./Source/ArmoniK
### Execute Samples

<!-- TODO: Verify how to execute samples -->
* Execute [tools/tests/symphony_like.sh](https://github.com/aneoconsulting/ArmoniK.Samples/blob/main/tools/tests/symphony_like.sh) from the **root** repository:
* Execute [tools/tests/unified_api.sh](https://github.com/aneoconsulting/ArmoniK.Samples/blob/main/tools/tests/unified_api.sh) from the **root** repository:

```bash [shell]
tools/tests/symphony_like.sh
tools/tests/unified_api.sh
```

::alert{type="info"}
Expand Down
265 changes: 0 additions & 265 deletions .docs/content/1.installation/1.linux/4.deploy-script.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ make bootstrap-destroy PREFIX=<PREFIX_KEY>
To access your Kubernetes cluster, execute the following command after entering your settings in the 3 angle brackets:

```bash
aws --profile <AWS_PROFILE> eks update-kubeconfig --region <AWS_REGION> --name <NAME_AWS_EKS>
aws --profile <AWS_PROFILE> eks update-kubeconfig --region <AWS_REGION> --name <NAME_AWS_EKS>
```

or simply enter the following command:
Expand All @@ -46,10 +46,10 @@ export KUBECONFIG=<PATH_TO_AWS_FOLDER>/generated/kubeconfig

## Configuration

All parameters are contained in [`parameters.tfvars`](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/aws/all-in-one/parameters.tfvars)
All parameters are contained in [`parameters.tfvars`](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/aws/parameters.tfvars)

::alert{type="info"}
By default, all the cloud services are set to launch. To see what kind of parameters are available, read [`variables.tf`](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/aws/all-in-one/variables.tf)
By default, all the cloud services are set to launch. To see what kind of parameters are available, read [`variables.tf`](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/aws/variables.tf)
::

You can specify a custom parameter file. When executing the `make` command, you may use the `PARAMETERS_FILE` option to set the path to your file.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ It is possible to setup the authentication in different ways when deploying Armo

# Deployment configuration

For each of the following configuration, the required parameters in your [```armonik/parameters.tfvars```](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/localhost/armonik/parameters.tfvars) to specify are:
For each of the following configuration, the required parameters in your [```parameters.tfvars```](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/localhost/parameters.tfvars) to specify are:

- ```ingress.mTLS```: Controls whether the ingress requires user certificates
- ```ingress.generate_client_cert```: Controls whether the deployment generates the default certificates with different roles
Expand Down Expand Up @@ -63,7 +63,7 @@ Using this configuration, anyone with access to the endpoints can send any reque
| ```authentication.require_authorization``` | ```false``` |
| ```authentication.authentication_datafile``` | ```""``` |

Using this configuration, a default client certificate will be generated. Anyone can access the endpoints using this certificate. Since this certificate will be put in the database by default, the parameter ```authentication.require_authentication``` can be set to true or false. The default client certificate created is ```infrastructure/quick-deploy/localhost/armonik/generated/certificates/ingress/client.submitter.crt```
Using this configuration, a default client certificate will be generated. Anyone can access the endpoints using this certificate. Since this certificate will be put in the database by default, the parameter ```authentication.require_authentication``` can be set to true or false. The default client certificate created is ```infrastructure/quick-deploy/localhost/generated/certificates/ingress/client.submitter.crt```

## How to setup mTLS authentication using a custom certificate authority

Expand All @@ -89,7 +89,7 @@ Using this configuration, the specified ```ca.pem``` will be used to authenticat
| ```authentication.require_authorization``` | ```true``` |
| ```authentication.authentication_datafile``` | ```""``` |

Default certificates are generated alongside the automatically generated client certificate authority. In this case, two certificates are generated in the ```infrastructure/quick-deploy/localhost/armonik/generated/certificates/ingress``` folder : ```client.submitter.crt``` which corresponds to a user with all permissions, and ```client.monitoring.crt``` which corresponds to a user with only monitoring permissions. You can modify the default users and roles created by modifying the module file [armonik/authentication-roles-default.tf](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/modules/armonik/authentication-roles-default.tf).
Default certificates are generated alongside the automatically generated client certificate authority. In this case, two certificates are generated in the ```infrastructure/quick-deploy/localhost/generated/certificates/ingress``` folder : ```client.submitter.crt``` which corresponds to a user with all permissions, and ```client.monitoring.crt``` which corresponds to a user with only monitoring permissions.

## How to setup your own certificates for authentication

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To install and configure the partitioning there are some modifications to implem

In the version 2.8, the partitioning was not available in ArmoniK but the infrastructure was ready for this functionality. A default partition was created at deployment time with the name `default`.

To use multiple partitions, a functionality which is now available with the version 2.9, the first step is to modify the infrastructure deployment with the desired configuration for the partitions. On an AWS deployment, this is done in the file [infrastructure/quick-deploy/*/armonik/parameters.tfvars](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/aws/armonik/parameters.tfvars), specifically in the variable `compute_plane`.
To use multiple partitions, a functionality which is now available with the version 2.9, the first step is to modify the infrastructure deployment with the desired configuration for the partitions. On an AWS deployment, this is done in the file [infrastructure/quick-deploy/*/parameters.tfvars](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/aws/parameters.tfvars), specifically in the variable `compute_plane`.

This variable is a map whose key is the partition name and the value is the partition configuration.

Expand Down
10 changes: 8 additions & 2 deletions .docs/content/2.guide/1.how-to/how-to-configure-seq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# How to configure SEQ?

If you want to access outside your Kubernetes cluster, you have to configure Seq to make it accessible from outside.
To do so, you have to set this service (`seq_web` in [seq.tf](../old/armonik-deployments/armonik/modules/armonik-components/seq.tf#L92) ) as `LoadBalancer` instead of `ClusterIP`.
If you want to access outside your Kubernetes cluster, you have to configure Seq to make it accessible from the outside.
Edit the [parameters.tfvars](https://github.com/aneoconsulting/ArmoniK/blob/main/infrastructure/quick-deploy/localhost/parameters.tfvars), and edit the `seq` section (or add it if not present). Add the `service_type` option:

```tfvars
seq = {
service_type = "LoadBalancer"
}
```

Then, redeploy.

Expand Down
Loading

0 comments on commit 984de35

Please sign in to comment.