app distribution service for pcf - resources.docs.pivotal.io · pivotal tracker integration...
TRANSCRIPT
AppDistributionService
forPCFDocumentation
Published:21March2019
©2019PivotalSoftware,Inc.AllRightsReserved.
235716
TableofContents
TableofContentsAppDistributionAppDistributionReleaseNotesInstallationCreate&ReleaseBuilds
©CopyrightPivotalSoftwareInc,2013-2019 2 1.3.6
AppDistribution
ProductSnapshotThefollowingtableprovidesversionandversion-supportinformationaboutAppDistributionforPCF:
Element Details
Version v1.3.6
Releasedate May16,2016
CompatibleOpsManagerversion(s) v1.5.xandlater
CompatibleElasticRuntimeversion(s) v1.5.xandlater
IaaSsupport AWS(onlyforPCFv1.4.xandlater)andvSphere
Considerthefollowingcompatibilityinformationbeforeupgrading:
OpsManagerVersion SupportedUpgradesfromImportedAppDistributionInstallation
1.3.x 1.0to1.0.1.26
1.4.x 1.0.1.28only
1.5.x1.0.1.28to1.1.0.0
1.1.0.0to1.2.1.0
1.6.x
1.1.0.0to1.2.1.0
1.1.0.0to1.2.2.0
1.1.0.0to1.2.3.0
1.2.1.0to1.2.2.0
1.2.xto1.3.5
1.7.x1.3.5to1.3.6
1.3.5to1.3.8
InstallationPleasefollowtheseinstructions toinstallviaOpsManager.
BackupandrestoreFollowtheseinstructions tobackupandrestoretheMySQLdatabasecontents.
These[instructions]canbeusedtobackupandrestoretheRedisdatabase.
AboutThePivotalAppDistributionservice providesPivotalCloudFoundry userswithareleaseprocessfortestingandsharingmobileappscurrentlyindevelopment.CurrentmobileplatformssupportedincludeiOS,Android,BlackBerry,andWindowsPhone.
©CopyrightPivotalSoftwareInc,2013-2019 3 1.3.6
Atypicalusecaseisasfollows:
1. IntheAppDistributionwebportal,adevelopercreatesa‘release’ofanapp(currentlyindevelopment)forQAtesters.Developerscanaddreleasenotes,knownissues,listsofsupporteddevicesandOSversions,etc.
2. TheQAtestingteamisnotifiedofthereleaseviaemail.Theycantheninstall(viaover-the-airdownload)andtesttheappondevice.Pendingsuccessfulcompletionoftesting,QAthenapprovesthereleasefordistribution.
3. Onceapproved,thedevelopercanthendistributethereleasetoalargergroupofteammembers,whichcanincludebetatesters,projectstakeholders,etc.
©CopyrightPivotalSoftwareInc,2013-2019 4 1.3.6
AppDistributionReleaseNotes
PreviousReleases
1.3.8Updatedtoboshstemcellv3146.12
1.3.6Updatedstemcelltoversion3232.2
1.3.5MaintenancereleasetoremoveNewRelicinfo
1.3.4Updatedstemcelltoversion3146.10toaddressUSN-2929-1
1.3.3Updatedstemcelltoversion3146.9
1.3.0APIsavailableforbuildautomation(userscannowcallasetofcurlcommandstocreateabuild,uploadatestfile,addreleasenotes,releasedbuilds,etc.)
1.2.5UpdatedBoshstemcelltoversion3146.2inordertoaddressthefollowing:
USN-2857-1 USN-2842-1 USN-2842-2 USN-2836-1 USN-2834-1 USN-2830-1 USN-2829-1
1.2.3Updatedstemcelltoversion3130.Thisisaregularsecurityupgradethatresolvesthefollowingissues:
USN-2806-1 Linuxkernel(VividHWE)vulnerability
USN-2798-1 Linuxkernel(VividHWE)vulnerabilities
©CopyrightPivotalSoftwareInc,2013-2019 5 1.3.6
1.2.2Fixtodisableverboseloggingduringinstallationprocess
1.2.1SupportforPCF1.6
APItouploadfilestobuilds
MinorbugfixesandUIupdates
1.1.0ProvidedAPIsthatcanbeusedbyCIscriptstocreateabuildanduploadafile
MinorUIupdates-newloginpage,viewloginprofile(fromuseriddropdown)
1.0.1.28SupportforexternalMySQLandRedisservices
SupportforPCF1.4onAWS
Knownissues:
OnAWS,thisversionsupportsdeploymentsintheUS-Eastregion.Multi-regionsupportiscominginafuturerelease.
TheexperimentalHTTPS-onlyfeatureinElasticRuntime1.5maycauseissueswiththisversionoftheproduct.FullsupportforHTTPS-onlytrafficiscominginafuturerelease.
1.0.1.15Offlineinstallationsupport
CompatibilitywithPCF1.4(vSphere)
1.0.0Createaprojectfromwhichappreleaseswillbesent
PivotalTrackerintegration(featuresdelivered,bugsfixed,etc.)
Createandsharemultipleappreleasestotesters
Rolebasedaccess:
Administrator-create/viewallprojects,addprojectusers,andcreateappreleasesMember-createappreleasesandaddprojectusersViewers-viewappreleases(mustbeaprojectmember)
Note:BOSHStemcell2865.1isrequiredforinstallationonOpsManager1.5.xandabove.
©CopyrightPivotalSoftwareInc,2013-2019 6 1.3.6
InstallationForinstallation,aPivotalCloudFoundry AdministratorinitiallyimportsthePivotalAppDistribution packageintoPivotalCloudFoundryOperationsManager.
InstallationPrerequisitesPivotalCloudFoundry(ElasticRuntime andOpsMgr )
MySQLforPCF
SSLCertificate(forover-the-airinstallationofiOSapps)
SMTPprovider(forsendingbuildnotificationemails)
S3-compatibleobjectstoreAPI(forstoringreleaseinformation,includingapplicationbinaryfiles)
NOTE:Atypicalenterprisedeploymentwillrequiretwoapplicationinstances(AIs)
InstallingviaOpsManagerToinstallthePCFAppDistributiontileinOpsManager,pleasefollowthestepslistedbelow:
1. DownloadtheproductfilefromPivotalNetwork
2. UploadtheproductfiletotheOpsManagerInstallationDashboard(viathe‘ImportaProduct’button).
3. ClickAddnexttotheuploadedproductdescriptionintheAvailableProductsviewtoaddthisproducttoyourstagingarea.
4. ClickonthenewlyaddedtiletoentertherequiredTileConfigurationsettingsasshownbelow.
5. ClickApplyChangestoinstalltheproduct.
OpsManagersettingsFromstep4above,gotothe'Settings’TabafterclickingontheAppDistributiontileandupdatethefollowingconfigurationsettings
SMTPSettings
Requiredfieldvalues:
'FromEmail’-thisistheemailaddressthatwillbeusedtosendreleases
SMTPserveraddress
SMTPserverportnumber
HELOdomain(fromwhichemailswillbesent)
SMTPservercredentials(login&password)
Selectyourauthenticationmethod(plain,login,orcram_md5).
ClickSavetostoretheSMTPsettings.
©CopyrightPivotalSoftwareInc,2013-2019 7 1.3.6
StorageSettings
Requiredfieldvalues:
Bucketname
AccessKey
SecretKey
©CopyrightPivotalSoftwareInc,2013-2019 8 1.3.6
MySQLSettings
SelecttheMySQLDatabasetobeused-PCFMySQLoranExternalMySQLservice(PCFMySQListhedefaultsetting)
IfPCFMySQLisusedthenentertheappropriateserviceplan(typically'100mb-dev’)
©CopyrightPivotalSoftwareInc,2013-2019 9 1.3.6
IfanexternalMySQLserviceistobeusedthenenterthefollowingsettings
MySQLHost
MySQLPort
MySQLUsername
MySQLPassword
MySQLDatabase
BackupandRestoreMySQL
IfMySQLforPCFisbeingused,followtheseinstructions tobackupandrestorethedatabase
©CopyrightPivotalSoftwareInc,2013-2019 10 1.3.6
ProvisionaserviceinstanceforAppDistributionLogintothePCFconsole
Inthesystemorg,gotothe'app-distribution’space
Clickonthe'AddService’button:
©CopyrightPivotalSoftwareInc,2013-2019 11 1.3.6
Select'AppDistribution’fromtheServicesMarketplace
Selectthe'development’plan(provisionsasingleAppDistributioninstance)
©CopyrightPivotalSoftwareInc,2013-2019 12 1.3.6
Onthenextscreen(configureinstance),enterthefollowing:
1. Instancename:Enteravalue(i.e.'AppDistribution’)2. Addtospace:'appdistribution’3. BindtoApp:'donotbind’
Click'Add’.ThebrowserwillthenredirectbacktothePCFconsolepageshowingthenewlyprovisionedserviceinstance
ClickManageundertheinstancenametoaccesstheAppDistributionportal.
©CopyrightPivotalSoftwareInc,2013-2019 13 1.3.6
Clickthe'signinwithPivotalCloudFoundry’linkandentertheUAAadmincredentials(foundbyaccessingtheElasticRuntimetile’scredentialstabunderthe'UAA’section)
Uponsuccessfullogin,thehomepageshouldappearasshownbelow:
©CopyrightPivotalSoftwareInc,2013-2019 14 1.3.6
RefertotheUserGuideforinstructionsonhowtoaddusersandcreateanappbuildrelease.
©CopyrightPivotalSoftwareInc,2013-2019 15 1.3.6
Create&ReleaseBuilds
Createaprojectandadduserstotheprojectteam1. ClickNewProject.(i.e.settingupanewAppprojectpagefromwhichthereleasewillbesent)
2. AddProjectName,ClientName,Platform,Description,andprojectmailinglist.
3. AddPivotalTrackerandToken(ifTrackerhasbeeninstalled).
4. AddUserstotheprojectandassignaroleasdescribedbelow:
Administrator-Canadduserstoaproject,createreleases
Member-CancreatebuildstosendtoQAandclients.CanalsoreceiveQAbuilds
Viewer-CanonlyviewreleasesthathavebeenapprovedbyQAandreleasedtotheprojectteam
Create&ReleaseabuildtoQA1. Clickaddphaseandenteraphasename.
2. Clicknewbuildlink.
3. Selectthephasenamefromthedropdownmenu.
4. Clickbrowsefilestouploadtheappropriatemobileappbinaryfile.
5. Iftestingamobilewebapp,entertheURLandalabelname(i.eurlshortcut).
6. Clickaddtouploadanyadditionalfilesorurls(fortesting,documentation,etc.).
7. IntheQAReleaseNotessection,entervaluesfortherequiredfields(indicatedby’*’).
8. ClickSaveatbottomright.
9. ClickSubmitforTesting.
10. Includeprojectteammemberswhowillreceivethebuild(sentviaemail).
11. ClickRelease.
12. Verifythatthe‘Pass’and'Fail’buttonsaredisplayed.
InstallAppasaQAtester1. Accessthebuildreleaseemailfromtheappropriatemobiledevice(notethatinstallingovertheairisavailableonlyforiOSandAndroiddevices).
2. Inthebuildreleaseemailmessage,clickInstallBuild.ThisopenstheSafaribrowseranddisplaystheloginpagefortheappdistributioninstance.
3. Uponsuccessfullogin,thebuildpagedisplays.
4. ClickInstallnexttotheappropriatebuildfile.
5. Thebuildfileshouldthensuccessfullydownloadtothemobiledevice.
6. Oncethebuildhaspassedtesting,clickPass.
Note:UserscannowuseAPIsforbuildautomation(curlcommandtocreateabuild,uploadafile,releaseabuild,etc.).Pleasereferencethislinkformoreinformation.
©CopyrightPivotalSoftwareInc,2013-2019 16 1.3.6
7. Verifythatthe'ShareRelease’buttonisdisplayed.
Releasebuildtoprojectteam1. AddAppfiles.
2. AddReleasenotes.
3. ClickShareRelease.
4. Theprojectmailinglistisselectedbydefault.Selectanyadditionalteammembersifneeded.
5. ClickRelease.
6. Selectedprojectteammembersandanyoneonthemailinglistwillreceivethereleaseemail.
©CopyrightPivotalSoftwareInc,2013-2019 17 1.3.6