Projects

Projects are used to define logical teams and separate definitions and access of like services. Projects control member access to services and executions as well as to Git Repos and Secrets.

Following, we walk you through the Projects setup and maintenance:

  1. Click on Projects in the menu on the left side to open dropdown and then on List Projects
  2. Click on "+Add"

  1. Name the new project
  2. Save

Ferris Projects form the overarching organizational bracket for different types of objects. All users, packages, scripts, parameters, secrets and other elements are organized into projects to ease enterprise data management. The default owner for new projects is the Platform Admin (PA).

Once created, a project consists of the following components, each represented by a separat tab:

  • Details
  • Charts
  • Project Users
  • Services
  • Git Repositories
  • Secrets

Details

This tab acts as an overview page to the project.

A number of predefined widgets show the status of the project and its latest executions.

Clicking the edit button, the project name may be changed.

Charts

Charts are useful graphical widgets that summarize the hostory and health of any particular service or execution.

New charts can be added by any user to a project.

Charts creation is documented in the User Guide > Charts

Project Users

The creator of a new Project is automatically assigned the Project Owner role. There are multiple roles available within a project. These are defined as follows:

  • Project Owner - has all permissions on the project and related components (packages, users), including the deletion of the project, its repos, services, secrets and users. By default it is the user that created project. However, there can be multiple Project Owners assigned to one project.
  • Project Admin - has all permissions as Owner except deletion
  • Project User - has only list / view permissions

Note that users with an assigned Administrator role (see Security section), may see all projects, even those that they are not a member of. Standard users do not see any projects and packages they are not assigned to.

All rights of a project role are translated to package level. A user with a Project User role will therefore not be able to edit packages of that project, but only to list and view them and run a (manual) execution.

Services

This tab contains all Services that belong to the project.

A Service may belong to only one Project. However, multiple Services may belong to one Project.

Git Repositories

One of the Ferris core strength is its direct and real-time integration to Git. By connecting a Git Repository with Ferris, any code snippet may be executed as soon as it is checked into the repo.

Integrations may be done on a branch and environment basis. For example: The Git Main branch may be mapped to the Ferris Production environment, while the Git Dev branch is mapped to Ferris Dev / Test.

Connecting and integrating Git Repos is fully secured and transparent by using Key Value Pairs, stored in Git and Ferris.

Secrets

Project level Secrets may inlcude API key, digital certificates or passwords. By definition, these are only available to Services and Users within the project.


Last modified November 24, 2023: update (f4bc5ea)