Skip to main content
Git Interface

Manage Project

Learn how to manage a project in your CloudFlow organization.

Create project​

Follow the steps below to create a project:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the top right of the page, click Create Project and then follow the provided steps.
note

Creating a project can take a few minutes to complete once submitted.

Delete​

Follow the steps below to delete a project:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, click the settings button in the top right of the project card that you want to delete.
  4. Click Delete Project.
  5. Enter the project name and click Delete Project.
caution

Ensure all traffic has been migrated before deleting a project.

Add environment​

Follow the steps below to split a project:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, click the settings button in the top right of the project card that you want to add an environment in.
  4. In the secondary left sidebar, open the dropdown menu of your project and click Add environment.
  5. Enter the new environment name and initial domain name and then click Create Environment.

Delete​

Environments cannot be deleted at this time.

Git​

Follow the steps below to configure your environment:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, find and click the project you want to configure.
  4. In the secondary left sidebar, open the dropdown menu of the project and select the environment you want to configure (e.g. Production).
  5. In the left sidebar, click Git.
  6. Find the Directory of the file you want to configure. Expand the File Path and click Edit.
  7. Configure the environment with Git either fully from a command line interface (CLI) or partially through the web user interface.
note

The configuration of an environment is controlled by the associated Git repository hosted by CloudFlow. Clone, commit, and push changes to the Git repository for your environment in the same way as any other Git repository, for example:

git clone https://aperture.section.io/account/1/project/1/www.example.com.git
...
cd www.example.com
touch README.md
git add .
git commit -m "Add README.md"
git push
tip

Clone with HTTPS by using section-token as the username and an API token as the password instead of the username and password of your CloudFlow user, for example:

git clone https://aperture.section.io/account/1/project/1/www.example.com.git
Cloning into 'www.example.com'...
Username for 'https://aperture.section.io': section-token
Password for 'https://section-token@aperture.section.io': <api_token>

Clear cache​

Follow the steps below to clear the cache for an environment in your project:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, find and click the project you want to clear the cache for.
  4. In the secondary left sidebar, open the dropdown menu of the project and select the environment you want to clear the cache for (e.g. Production).
  5. In the secondary left sidebar, click Clear cache.
  6. In the top subnavigation bar, click the module you want to clear the cache for. This can be done for the following modules:
note

Clearing the cache takes under 200ms for all locations to be cleared.

caution

Clearing the cache can temporarily increase traffic sent to the origin.

IP restrictions​

Follow the steps below to set up request restrictions by IP address for an environment in your project:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, find and click the project you want to set up request restrictions for.
  4. In the secondary left sidebar, open the dropdown menu of the project and select the environment you want to set up request restrictions for (e.g. Production).
  5. In the secondary left sidebar, click IP Restrictions.
  6. Add, edit, or delete IP addresses and/or CIDR blocks and then click Save.
note

IP restrictions are added to the first layer of an environment's proxy stack (edge proxy).

tip

IP restrictions can also be set in the section.config.json file.

Origins​

Follow the steps below to set up the origin(s) for an environment in your project:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, find and click the project you want to set up the origin(s) for.
  4. In the secondary left sidebar, open the dropdown menu of the project and select the environment you want to set up the origin(s) for (e.g. Production).
  5. In the secondary left sidebar, click Origins.
  6. Add, edit, or delete origin configurations and then click Save changes.
note

Alternate origins require the section-origin request header to be set in the proxy stack. The value must be the alternate origin name.

Alternate origins that are removed or renamed can continue to honor the old name, in addition to the new configuration. The old definitions will only be removed as old Egress Pods are eventually replaced.

tip

Origins can also be set in the section.config.json file.

Monitoring​

Follow the steps below to view real-time monitoring for your project and all of its environments:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, find and click the project you want to view real-time monitoring for.
  4. Within the project card, click the Grafana icon on the right.
tip

Check out the related Grafana documentation to get started with customizing your monitoring dashboards.

DNS​

Follow the steps below to set up the DNS for an environment in your project:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, find and click the project you want to set up the DNS for.
  4. In the secondary left sidebar, open the dropdown menu of the project and select the environment you want to set up the DNS for (e.g. Production).
  5. In the secondary left sidebar, click Domains.
  6. Add and delete environment domains, create a new hosted DNS zone, or temporarily pause traffic from going through CloudFlow.

HTTPS​

Follow the steps below to set up the SSL/TLS certificate(s) for an environment in your project:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, find and click the project you want to set up the SSL/TLS certificate(s) for.
  4. In the secondary left sidebar, open the dropdown menu of the project and select the environment you want to set up the SSL/TLS certificate(s) for (e.g. Production).
  5. In the secondary left sidebar, click SSL Setup.
  6. Set up the SSL/TLS certificate(s) for the environment domain(s) in your project either through an automatically generated Let's Encrypt certificate or by uploading a custom certificate.
note

Let's Encrypt certificates are automatically renewed and cannot be used for wildcard domains. Please note Let's Encrypt imposes rate limits that you must follow.

Outage pages​

Follow the steps below to set up outage pages for an environment in your project:

  1. Log in to your CloudFlow organization.

  2. In the left sidebar, click Projects.

  3. In the projects list, find and click the project you want to set up outage pages for.

  4. In the secondary left sidebar, open the dropdown menu of the project and select the environment you want to set up outage pages for (e.g. Production).

    Create outage page​

    1. In the Git config, create an outage_pages directory in the root directory of the environment repository.

    2. In the outage_pages directory, add your outage pages in HTML format with the .html extension, for example:

      .
      ├── custom_errors
      │   └── 500.html.sample
      ├── local.config.json.sample
      ├── outage_pages
      │   ├── maintenance.html
      │   └── sale.html
      └── section.config.json
      caution

      Outage pages cannot contain resources hosted within the environment that the outage page will be engaged on.

    Engage outage page​

    1. In the left sidebar, click Outage Pages.

    2. In the outage pages list, select a page and then click Engage.

      note

      Engaged outage pages are displayed for all environment domains.

    Disengage outage page​

    1. In the left sidebar, click Outage Pages.
    2. In the outage pages list, click Disengage.

Custom error pages​

Follow the steps below to set up custom error pages for an environment in your project:

  1. Log in to your CloudFlow organization.

  2. In the left sidebar, click Projects.

  3. In the projects list, find and click the project you want to set up custom error pages for.

  4. In the secondary left sidebar, open the dropdown menu of the project and select the environment you want to set up custom error pages for (e.g. Production).

  5. In the Git config, go to (or create) the custom_errors directory in the root directory of the environment repository.

  6. In the custom_errors directory, add your custom error pages in HTML format with the .html file extension and the status code it represents as the file name, for example:

    .
    ├── custom_errors
    │   ├── 403.html
    │   ├── 404.html
    │   ├── 500.html
    │   ├── 502.html
    │   ├── 503.html
    │   └── 504.html
    ├── local.config.json.sample
    ├── outage_pages
    │   ├── maintenance.html
    │   └── sale.html
    └── section.config.json
    note

    Custom error pages can only be created for valid nginx status codes between 300 and 599 (excluding 499). Pages for the 502 and 504 status codes will also be applied to 522 and 524.

Whitelist origin requests​

Follow the steps below to whitelist origin requests for an environment in your project:

  1. Log in to your CloudFlow organization.
  2. In the left sidebar, click Projects.
  3. In the projects list, find and click the project you want to whitelist origin requests for.
  4. In the top navigation bar, select the environment you want to whitelist origin requests for (e.g. Production).
  5. In the Git config, use one of the following modules to add a secret request header to whitelist on the origin:
note

Submit a support request by clicking the Support link in the left sidebar if you are interested in whitelisting origin requests by IP address.