A project in ZEDEDA Cloud is a container that groups assets such as edge nodes, applications, and deployments so that they can be more easily managed. When you create an asset in your enterprise, ZEDEDA prompts you to assign that asset to one of your projects. Then, according to your project- and asset-level configurations, your projects will automatically coordinate their assigned assets, serving your business segmentations, functional or geographical segmentations, or some other aspect of your business logic.
Projects exist in ZEDEDA in the following ways: Each project belongs to a single enterprise. When you create your enterprise, it will contain a single empty project. You may create many projects in the same enterprise.
There are two types of projects: Deployment and Legacy. Deployment projects are always configured with the Regular profile, while legacy projects may be regular or they may be optionally configured with the Azure profile.
NOTE: Administration of your projects is easier when you use symmetrical edge nodes (same brand, model, and hardware configurations). Doing so, however, is not mandatory.
View your projects
Use the ZEDEDA GUI
To view a list of your enterprise's projects, go to your Projects page by hovering over Administration on the side nav, then click Projects. Your Projects page also has a summary panel, which displays essential metrics related to your projects in aggregate.
Project status meanings:
| Legends | Description |
|
|
The Project is ready to use. |
|
|
The Project is not ready to use. |
| Status not used currently. | |
|
|
The project status is not known. |
|
|
The project status shows this status until the policy is created. |
| Status not used currently. |
Use the ZCLI
You can use the following command to see the created Project details:
zcli> zcli project show [[[<name> | --uuid=<uuid>] [--detail]] | [--name-pattern=<name-pattern>]]
For example, the show command for Project displays the following output:
zcli> zcli project show
Project Title Description State
------------ ---------------- --------------------- --------
test-project2 test-project2 test-project2 TAG_STATE_ACTIVE
Project_100 Project_100 Default Project TAG_STATE_ACTIVE
test-project1 test-project1 test-project1 TAG_STATE_ACTIVE
default-project default-project Default Project TAG_STATE_ACTIVE
test-project test-project test-project TAG_STATE_ACTIVE
Total 5 Active 5
Project details
To view the details of an individual project, find it on the Projects page and click on it. On the details page, you will see three tabs: Basic Info, Policies, and Events.
Basic Info
Here, you edit your project's Title and Description. The Id, Name, Type, and Profile fields are configured during project creation and may not be edited thereafter.
Basic Info field meanings:
| Input Field | Value |
| Name(*) | This is unique across the Enterprise and cannot be changed. |
| Title(*) | This is user-defined and can be changed. |
| Description | A detailed explanation of what the Project is used for. Not mandatory. |
| Profile |
You will need to select 'Cloud Profile' using the dropdown menu.
|
Note: The following sections have details for the 'Regular' type of cloud profile. Click here for more information on Azure Projects.
Policies
Policies govern the behavior of a project. The specific set of policies required by a project depends on the project's type and profile.
The following policies are common:
- Enforce edge node Attestation: See Remote Attestation Overview for more details.
- Network Instance Policy: If selected and defined, the network instance(s) should be automatically deployed to all edge nodes used by edge application(s) part of a particular project.
- Edge App Policy: If selected and defined, this policy will be applied to all the edge nodes that are part of this Project. If a new edge node is added to this Project, the 'Edge App Policy' will occur.
The status of projects depends upon the status of the attached policies.
| Input Field | Value |
| Enforce Edge Node Attestation | The checkbox needs to be checked to enforce the edge node attestation. |
| Edge App Policy | The checkbox needs to be checked to enable the automatic deployment of a particular edge application. Select an appropriate edge application(s) from the dropdown that should be automatically deployed to all edge nodes which are a part of the project being created. |
Note: For Azure and regular projects, if an edge application is deployed using the edge app policy, the application gets deleted once the edge node is moved from one Project to another.
- Step 5 > When you click on the 'Add' button, a toast message appears as shown below:
- Step 6 > You can see that the new Project is added in the Projects list view.
Events
Events are significant changes in configuration or status to a project.
a) Info
Lists all the events that occurred, sorted with date and time, in a table. You can see details based on the type of severity, the source from where a particular event is generated, the edge node, and related Edge Application Instances on which the event has occurred, along with descriptions, in different tabs.
b) Summary
The event summary can be viewed by clicking on the expand () icon. You can see details of the change in state, the severity type, debug info, etc.
Create a project
Use the ZEDEDA GUI
The first time you add a project might be while you’re onboarding an edge node to ZEDEDA Cloud.
If you are not onboarding an edge node, but adding a project separately, navigate to Projects as follows:
- Hover over Administration in the left panel and select Projects.
- Click the plus icon.
- Fill in the required fields in the Details page. Click Next.
- Fill in the required fields in the Deployments page. Click Next.
- Select and configure the policies you wish to apply to the project. Click Next.
- Review your configurations and if everything looks right, click Add.
Use the ZCLI
Use the following command:
zcli> zcli project create <NAME> [--title=<TITLE>] [--description=<DESCRIPTION>] /
[--policy-config=<type:CONFIG_PATH>...]
Be sure to replace the following placeholders: <NAME>, <TITLE>, <DESCRIPTION>, <CONFIG_PATH>.
Update a project
Use the ZEDEDA GUI
From the Projects page...
The update/edit operation can only be performed in the Project detail view. After you log in to ZedControl, click on the Administration (
) icon and select 'Projects' to go to the list of already available projects. Click on any of the projects in the list view to show the detailed view of the same.
The update/edit view shows only the 'Info' section.
Basic Info
Update/edit a Project using the following steps:
-
Click on the Edit (
) icon.
- Update the editable fields of the 'Details' section. Refer to the tables under the create operation for information on the editable field values and their descriptions.
- In the policies section, check the 'Enforce Edge Node Attestation' checkbox if needed.
- Click on 'Submit' button.
Use the ZCLI
You can update a Project using the following command:
zcli> zcli project update <NAME> [--title=<TITLE>] [--description=<DESCRIPTION>] /
[--config=<key:value>...] [--policy-config=<type:CONFIG_PATH...>]
Be sure to replace the following placeholders: <NAME>, <TITLE>, <DESCRIPTION>, <CONFIG_PATH>.
Delete a project
Use the ZEDEDA GUI
The delete operation can be performed in both the Project list view and detail view. After you log in to ZedControl, if you no longer require the Project, you could delete it using the following steps:
- Click on the checkboxes of the Projects list on which the required operation needs to be performed.
-
Click on the More (
) icon on the top right corner.
- From the dropdown, select 'Delete'.
- Click the 'Confirm' button on the modal dialogue which appears as below:
- When you click on the 'Confirm' button, a toast message announcing the successful submission of the delete request of the projects appears.
Deleting these 3 Project(s) will permanently remove the data bout these Project (s) from management platform.
Note: There is no way to reclaim the data, after the delete operation is performed.
Use the ZCLI
You can delete a Project using the following command:
zcli> zcli project delete <name> [-f]
Be sure to replace the placeholder <NAME>.
Note: -f is to forcefully make the delete request to the ZedControl, without prompting the user.