Skip to main content

Integrates

Integrates is the product responsible for the platform and its API.

Public Oath​

  1. The platform is accessible at app.fluidattacks.com.
  2. Changes to the user interface of the platform that are "significant" will be announced via the appropriate communication mechanism.
  3. The API is accessible at app.fluidattacks.com/api.
  4. The API is backward compatible, meaning that no changes made to it by the Developers should break the End Users code that depends on it.
  5. A six-month notice period will be given should backward incompatible changes need to be made in the API, for example, but not limited to: deprecating attributes and entities, making optional arguments mandatory, changes in the authentication or authorization system, and so on.

Architecture​

  1. Integrates is a standard client-server application divided into a front-end, a back-end, and out-of-band computing tasks.

  2. Integrates has three environments:

    • The productive environment (prod_integrates) is used by the End Users and is deployed by the CI from the trunk branch on GitLab.

    • The development environment (dev) is used by developers and is deployed by the CI from each developer's branch on GitLab with a name equal to the branch it was deployed from.

    • The local environment is deployed by each developer on their personal computers. However, this environment is not represented or further explained in this architecture, but instructions can be found below.

  3. The front-end is deployed into AWS S3 buckets, using the corresponding bucket for the environment (development, or production).

  4. Static DNS entries point to the corresponding S3 buckets on Amazon Web Services (AWS), allowing Cloudflare to cache their content for a while.

  5. The back-end is deployed into the Kubernetes cluster provided by the Cluster component of Common, into the corresponding namespace for the environment (dev or prod_integrates).

  6. Dynamic DNS entries are generated automatically for each back-end deployment using the Kubernetes ingress controller for AWS, which essentially binds the corresponding domain to an AWS Elastic Load Balancer (ELB) that routes traffic from the internet into the corresponding cluster nodes, allowing Cloudflare to act as a firewall between the internet and the web application, and providing rate-limiting.

  7. The backend uses:

  8. The Database is backed up using Backup Vaults by Amazon Web Services (AWS) as promised in 1 and 2.

  9. The Compute component of Common provides us with out-of-band processing power that we use for things like periodic tasks (schedules), or tasks that can be computed outside of the request/response lifecycle and/or that require more beefy machines (like generating PDF reports).

tip

You can right-click on the image below to open it in a new tab, or save it to your computer.

Architecture of Integrates

Contributing​

Please read the contributing page first.

Development Environment​

Follow the steps in the Development Environment section of our documentation.

When prompted for an AWS role, choose dev, and when prompted for a Development Environment, pick integratesBack.

Local Environment​

Two approaches for deploying a local environment of Integrates are described below. Either of them will launch a replica of app.fluidattacks.com and app.fluidattacks.com/api on localhost:8001.

All in one​

You can use mprocs for handling all components in a single terminal:

  • Run m . /integrates.
  • Jobs can be restarted using r.
  • Jobs can be stopped using x.

Individual components​

Run each of the following commands in different terminals:

universe $ m . /integrates/back dev
universe $ m . /integrates/db
universe $ m . /integrates/front
universe $ m . /integrates/storage/dev

Each terminal will serve a key component of Integrates.

Accessing local environment​

  1. Go to https://localhost:3000 and accept the self-signed certificates offered by the server.

    This will allow the backend to fetch the files to render the UI.

  2. Go to https://localhost:8001 and, again, accept the self-signed certificates offered by the server.

    Now you should see the login portal of the application.

Ephemeral Environment​

Once you upload your local changes to your remote branch in Gitlab, a pipeline will begin and run some verifications on your branch.

Some of those verifications require a complete working environment to test against. This environment can be found at https://<branch_name>.app.fluidattacks.com, and it will be available once the pipeline stage deploy-app finishes.

In order to login to your ephemeral environment, SSO needs to be set up for it. You can write to [email protected] with the URL of your environment so it can be configured.

Enable SSO on Ephemeral Environments​

Google​

This requires you to have access to the Fluid Attacks organization on Google Cloud.

  1. Access the Google Cloud Console.

  2. Choose the project Integrates.

  3. On the left sidebar, choose APIs & Services > Credentials.

  4. On the Credentials dashboard, under OAuth 2.0 Client IDs, choose the client ID not created by Google Services.

  5. Finally, under Authorized redirect URIs, add the URI of the ephemeral environment you want to enable SSO on, https://<branch_name>.app.fluidattacks.com/authz_google.

Last updated on