tracker issue : CF-4204911

select a category, or use search below
(searches all categories and all time range)
Title:

docker help page for API Manager has mistakes in environment variables listed

| View in Tracker

Status/Resolution/Reason: Open//

Reporter/Name(from Bugbase): Charlie A. / ()

Created: 08/01/2019

Components: Containers, CF Docker Image

Versions: 2018

Failure Type:

Found In Build/Fixed In Build: 1.0 /

Priority/Frequency: Normal /

Locale/System: / Windows 10

Vote Count: 0

The page (https://helpx.adobe.com/coldfusion/api-manager/docker-images-coldfusion-api-manager.html) has a few problems related to environment variable names.

1) In the "Environment Variables" section, the names shown for the apimanager image have names starting with "apim", like apimpassword. That is incorrect.

Instead, as per the help command (and testing) they start with "apim_", such as in apim_password. Use of the wrong names are simply ignored. These should be corrected.

2) Also, the list shown is missing two:
                apim_previousSerial=<Previous Serial Key (Upgrade)>
                apim_datastoreSeed=<Datastore Encryption Seed>

3) Finally, note that the var names are only presented only as values in a sample .env file. They should really be listed on their own, with more information.  Indeed, what I show in point 2 above is from the help command.

This web page should should just show the output of the help command for each of the the containers, such as this for the apimanager one (and after it I show the help for the addons one):

Supported commands: help, start <.cfm>
Required ENV Variables:
                apim_acceptEULA=YES
Optional ENV Variables:
                apim_serial=<Serial Key>
                apim_previousSerial=<Previous Serial Key (Upgrade)>
                apim_password=<API Manager Admin Password>
                apim_datastoreHost=<Datastore Hostname>
                apim_datastorePort=<Datastore Port>
                apim_datastorePassword=<Redis (Datastore) Password>
                apim_datastoreSeed=<Datastore Encryption Seed>
                apim_analyticsHost=<Analytics Server Hostname>
                apim_analyticsPort=<Analytics Server Port>
                apim_analyticsClusterPort=<Analytics Server Cluster Port>
                apim_analyticsClusterName=<ElasticSearch Cluster Name>


And this for the apimanager addons image:

Supported commands: help, start <.cfm>
Required ENV Variables:
                acceptEULA=YES
Optional ENV Variables:
                startDatastoreService=<true/false>
                startAnalyticsService=<true/false>
                datastorePassword=<Redis Password>
                analyticsClusterName=<Elastic Search Cluster Name>

Attachments:

Comments: