Managing the Project Catalog

A Project Catalog is a collection of software components that are available for UForge users to use when building their server templates. A project is one software component. A project includes files, binaries or native packages and may have an EULA (End User License Agreement).

Each organization within the UForge platform has a project catalog, and each member of the organization has access to the project catalog, allowing them to add any of the projects to their server templates. The contents of the project catalog, however, can only be updated and managed by the administrators of the organization where the project catalog belongs. An organization administrator can:

• add new projects to the catalog
• update existing projects to the catalog
• mark a project obsolete.
• delete a project.

You can also create custom OS profiles to include specific packages to an existing (standard) OS profile. See Creating Custom OS Profiles.

Adding a Project

To add a new project:

1. Under the Administration tab, click Projects.

2. If you are an administrator to more than one organization, then you can choose the organization to administer from the drop-down menu.

3. Click on add project in the top right hand.

   Note

   Projects are associated with a specific version of operating system. If a project supports more than one version of operating system, then you must re-create a new project for each operating system version. To automate the way projects are added and maintained, use the UForge APIs (for example to add the same project to multiple operating systems).

4. Fill in the mandatory information including:

   • Name of the project
   • Version
   • Project tag
   • Category
   • Maintainer

   

5. Click create.

6. Optionally, you can add the following meta-data on the Overview tab:

   • a logo for the project
   • website information of where the project came from
   • description

7. You can (optionally) restrict the distributions that the project applies to. On the Restrictions page select the distribution from the bottom list and click the upward arrow. Click save.

   

8. You can add files by clicking upload. If you want to add many files, you can create a folder and add files within the folder.

   

   If you want to include files from a remote location click on pull. Select how the file should be retrieved and if it should be cached.

   

9. You can add a license (optional). To do so,

   1. Go to the License tab
   2. Select the license type from the drop-down menu.
   3. Click upload.
   4. Select the file and click open.

10. You can add a bootscript (optional) on the Bootscript tab.

    1. Enter the name.
    2. Select the type. If you select first boot, then the boot script will be launched once the first time the instance is launched. If you select every boot, then the boot script will be launched every time the instance is rebooted.
    3. Set the boot order.
    4. Enter the boot script.

    

11. Click Save.

Updating a Project

UForge provides the default projects for the OSes provided.

To modify the projects:

1. Under the Administration tab, click Projects.
2. If you are an administrator to more than one organization, then you can choose the organization to administer from the drop-down menu.
3. Projects are associated with a specific version of operating system. Click on the operating system you want to modify. You will see a list of all the projects that are part of the OS.
4. Click on the project you wish to edit. At this stage you can change any of the meta-data and files uploaded.

Deleting a Project

When deleting projects from the catalog, it is important to understand that you should check that no appliance templates are using the project you wish to delete (otherwise this may break generating a machine image for the appliance template).

Note

If an appliance template is still using a project, you can remove the project from the catalog by marking it as obsolete. This does not delete the project contents, however users cannot use the project for new appliance templates. See Marking a Project as Obsolete for more information.

To delete the project:

1. Under the Administration tab, click Projects.

2. If you are an administrator to more than one organization, then you can choose the organization to administer from the drop-down menu.

3. Projects are associated with a specific version of operating system. Click on the operating system you want to modify. You will see a list of all the projects that are part of the OS.

4. To delete the project can either:

   click on the delete icon at the extreme right-hand side in the table for the project item.

   

   or

   click on the project item to edit it, then click on the delete icon at the top right-hand side of the project edit page.

   

Marking a Project as Obsolete

Another way to remove a project from the project catalog is to mark the project as obsolete. This ensures that any existing templates that use the project can still generate images correctly, however the project is no longer accessible in the catalog for new appliance templates.

To mark a project as obsolete:

1. Under the Administration tab, click Projects.
2. If you are an administrator to more than one organization, then you can choose the organization to administer from the drop-down menu.
3. Projects are associated with a specific version of operating system. Click on the operating system you want to modify. You will see a list of all the projects that are part of the OS.
4. Click on the project to edit it.
5. Click on the obsolete icon at the top right-hand side of the project edit page.