Uforge Appcenter Admin Documentation Release 3.8
Total Page：16
File Type：pdf, Size：1020Kb
UForge AppCenter Admin Documentation Release 3.8 FUJITSU Jun 10, 2019 Contents 1 Architecture Considerations 3 1.1 UForge Platform Overview.......................................3 1.2 Reliability................................................8 1.3 Security..................................................8 1.4 Storage Considerations..........................................8 1.5 Scalability through Partitioning..................................... 10 1.6 Image Generations............................................ 10 1.7 Estimating Scan Size........................................... 11 1.8 Deployment Examples.......................................... 11 1.9 Network Topology............................................ 12 1.10 Minimum Software Topology...................................... 13 1.11 Security Options............................................. 14 1.12 High Availability............................................. 14 2 Installing UForge 15 2.1 UForge Installation Overview...................................... 15 2.2 UForge Repository Setup........................................ 16 2.3 UForge Repository on Shared Storage.................................. 17 2.4 UForge Repository on Local Storage.................................. 17 2.5 Installing from an ISO.......................................... 18 2.6 Post-Installation Cleanup......................................... 19 2.7 Configuring UForge........................................... 19 2.8 Cloud Platform Default Ports...................................... 22 2.9 Testing the Deployment......................................... 22 3 Further AppCenter Configuration 25 3.1 Modifying the UForge Platform External URL Endpoints....................... 25 3.2 Adding a Compute Node......................................... 26 3.3 Removing a Node............................................ 28 3.4 Configuring Apache and Tomcat Web Services to use SSL Certificate................. 28 3.5 Configuring SMTP Proxy........................................ 30 3.6 Configuring UForge Behind Enterprise Proxy.............................. 31 3.7 Configuring the Web Service....................................... 31 3.8 Configuring the Database........................................ 32 3.9 Configuring the Scheduler........................................ 33 3.10 Managing the Watchdog Services.................................... 36 3.11 Tuning the Services........................................... 38 i 3.12 Using the Event Bus........................................... 42 3.13 Configuring Email Notification Service................................. 43 3.14 Modifying the UForge IP........................................ 45 3.15 Customizing UForge Authentication for SSO.............................. 48 3.16 Allowing https Repositories with Self-Signed Certificate........................ 51 3.17 Hosting Proprietary Packages...................................... 51 3.18 Populating ISO Skeleton......................................... 54 3.19 Configuring Cloudsoft AMP....................................... 54 3.20 Additional Configuration for Azure Stack................................ 56 3.21 Configuring Secret Manager....................................... 56 4 Updating your UForge AppCenter 59 4.1 Updating an Existing UForge Deployment............................... 59 4.2 Migrating UForge from 3.7 to 3.8.................................... 61 4.3 Going Back to a Previous Version of a UForge Deployment...................... 64 4.4 Retrieving Data from UForge...................................... 64 4.5 Sending a Request to UForge...................................... 64 5 Backup Overview Guidelines 67 5.1 Backup Overview Guidelines...................................... 67 5.2 Backup Recommendations........................................ 68 5.3 Using Master-Slave Replication for Database Backup......................... 68 5.4 UForge Databases Basic Backup..................................... 69 5.5 Basic Restore............................................... 70 5.6 User Data Backup............................................ 71 6 Managing Services 73 6.1 Starting and Stopping the Application Server.............................. 73 6.2 Starting and Stopping the Database................................... 73 6.3 Starting and Stopping the Secret Manager................................ 74 7 Managing Resources 75 7.1 Managing the Project Catalog...................................... 75 7.2 Allowing Access to Image Formats................................... 81 7.3 Managing the Organisation Artifact Accounts.............................. 84 7.4 Adding OS Distributions......................................... 85 7.5 Listing the Installed OSes........................................ 86 7.6 Listing the Enabled OSes with CLI................................... 86 7.7 Adding an OS to an Organization.................................... 87 7.8 Creating a Repository Using UI..................................... 90 7.9 Updating a Repository Using CLI.................................... 90 7.10 Removing OSes and Distributions.................................... 90 7.11 Updating an OS Repository....................................... 91 7.12 Deleting an OS Repository........................................ 92 7.13 Creating Custom OS Profiles with UI.................................. 92 7.14 Editing Custom OS Profiles Using UI.................................. 93 7.15 Official UForge Tool Repositories.................................... 94 7.16 Specific UForge Tool Repositories.................................... 95 7.17 Adding RPM Type OSes Using CLI................................... 96 7.18 Adding DEB Type OSes Using CLI................................... 99 7.19 Microsoft Windows and UForge..................................... 102 7.20 Creating a Golden Image from Scan................................... 104 7.21 Creating a Golden Image Manually................................... 106 7.22 Creating and Managing Categories................................... 114 7.23 Creating and Managing Milestones................................... 114 ii 8 Managing Users 117 8.1 Managing User Accounts........................................ 117 8.2 RBAC Overview............................................. 118 8.3 Granting a User Administrator Rights.................................. 123 8.4 Setting Quotas.............................................. 123 8.5 Managing User Access to Operating Systems.............................. 126 8.6 Managing User Access to Formats.................................... 127 8.7 Granting a User API Access....................................... 128 8.8 Granting a User Supervisor Rights.................................... 129 9 Monitoring Overview 131 9.1 Viewing the Web Service Logs...................................... 131 9.2 Viewing Current Jobs in the Scheduler................................. 132 9.3 Viewing the Logs of a Job........................................ 132 9.4 Configuring UForge to Send Logs to Elastic Stack........................... 133 9.5 Using Supervisor Mode......................................... 134 9.6 Getting Support............................................. 135 10 UForge Tooling 137 10.1 Using the CLI Tool............................................ 137 11 Rebranding Your UForge GUI 139 11.1 Creating Dedicated Image Directory................................... 139 11.2 Modifying the Sign-In and Sign-Up Page................................ 140 11.3 Modifying the Signed In Header..................................... 141 11.4 Modifying the Footer........................................... 142 11.5 Restricting Change Password...................................... 144 11.6 Restricting User Profile Usage...................................... 144 11.7 Restricting Formats........................................... 144 11.8 Restricting the Cloud Accounts..................................... 144 11.9 Customizing the CSS........................................... 145 11.10 Customizing the Platform........................................ 145 11.11 Customizing the Portal Text....................................... 146 11.12 Troubleshooting............................................. 147 12 3rd Party Components 149 12.1 Trademarks................................................ 149 12.2 Copyright FUJITSU LIMITED 2019.................................. 149 12.3 3rd Party Components Used....................................... 149 13 GDPR Compliance 155 13.1 User Data in UForge........................................... 155 13.2 Retrieving User Data........................................... 155 13.3 Updating User Data........................................... 159 13.4 Exporting User Data for Portability................................... 159 13.5 Deleting User Information........................................ 160 13.6 Deleting User Information Using SQL.................................. 162 14 Changelog 165 14.1 3.8.fp13.................................................. 165 14.2 3.8.fp12.................................................. 166 14.3 3.8.fp11.................................................. 167 14.4 3.8.fp10.................................................. 168 14.5 3.8.fp9.................................................. 169 14.6 3.8.fp8.................................................. 170 iii 14.7 3.8.fp7.................................................. 172 14.8 3.8.fp6.................................................. 173 14.9 3.8.fp5.................................................