209 Adding new deployments

To set up a new application deployment we need the information below.

Please fill out this document and send it to ops@makandra.de.

Hint

If you are unsure about any of the requirements (hardware, software, etc.), please contact the DevOps team at ops@makandra.de.

General information

Customer / Project

• Which customer or project does this deployment belong to?
• Is this deployment part of an existing contract?

Contact persons

• Which email address(es) should receive receive maintenance notifications? (usually project managers)
• Which email address(es) should receive error / cron failure notifications? (usually developers)

Deployment

Deployment name

• Name of the deployment (will be used as system user name, e.g. backend, cms, todolist)

Application description

• What does the application do?
• Is the application developed by makandra? (Yes / No)

Application type

• Ruby on Rails
• Container
  • Do you need access to a private container image registry? If yes, we will provide a secure way to share credentials.
• PHP
  • Which PHP version do you need?
• Elixir
• Static page
• Other: _______

Environments

• Which environments (e.g. staging, production) do you need? For each environment please provide:
  • Environment name
  • Planned first deployment date
  • Planned go-live date
  • SSH keys that should have access (public keys or names if already configured on another deployment)

Procfile support

• Does the application require Procfile support (e.g. for Sidekiq)?

Shared filesystem

• Is a shared filesystem (GlusterFS) required between app servers?
• Are additional symlinks needed beyond the default setup?

Database

Database type

• PostgreSQL
  • Required extensions (e.g. postgis, pgvector)
• MySQL / MariaDB
• Other: _______
• None

Query timeout

• Should we configure a timeout for SQL statements?

Additional software

• NodeJS required? (Yes / No)
• Redis required? (Yes / No)
  • If yes: For which purpose will Redis be used (e.g., Sidekiq, caching)?
• Do you need additional software or system packages?
  • Examples: libvips, Apache Tika, OpenSearch, ClamAV (Note: Additional software may require more server resources.)

Load balancer configuration

Domain

• Have you already registered a domain?
  • Yes, I have already registered a domain.
  • No, but I will purchase a domain by myself.
  • No, I want makandra to buy the domain for me (see details).
• Which domain(s) or subdomain(s) should point to this deployment?

Special routes

• Are there routes with non-default behavior?
  • Example: Protect /monitoring with BasicAuth.

Caching

• Should HTTP caching be enabled on the load balancers? Please review the details here.

Monitoring

• Is there a specific health check or monitoring endpoint that should be used?
• Do you need monitoring beyond the default checks?

E-Mail

• Does the application send emails?
• Which domain will be used as the sender domain?

Additional information

Deviations from defaults

• We use a standard set of defaults for our deployments. Do you require any deviations from these defaults?

Additional support required

• Is there any additional support we can provide?
  • Do you need support with setting up the deployment process (e.g. capistrano-opscomplete Show archive.org snapshot or a CI/CD pipeline)?
  • Do you need support for the initial deployment?
  • Do you need support with migrating an existing deployment?

Other information or questions

• Do you have any questions or further information?