Pilot Business Rules¶
Herein are described the rules for Pilot Eyebrow elements to allow for ease of discussion and help in debugging issues. Each top level element has a section.
Notes on User Types
- FAWS (Fanatical Support for AWS) users were indicated by identity role “fanatical_aws” and while that role was not removed, new users of AWS are not tagged with it.
- Managed GCP (Google Cloud Platform) were indicated by identiy role “managed_gcp”. At this time users are assumed to not be permitted to use Cloud.
- Datapipe users in Identity have a “RAX-AUTH:federatedIdp” value of “https://sso2.datapipe.com/saml2/idp/SSOService.php” and an “enterprise” authentication type. Other Datapipe users (in the context of the Datapipe control panel) do not have credentials in Identity, and are indicated simply by the “is_datapipe” configuration value.
- Dedicated users are currently indicated by identity role 16 AND “hybrid:<number>”. These users are actual Dedicated MyRack users only and not the ephemeral cloud users created by MyRack to allow users to use Cloud.
- Ephemeral Cloud-MyRack users do not have “hybrid:<>” and do not have role 16.
- Federated users have “RAX-AUTH:federatedIdp”: “<url of something>” in the response from identity
- Dedicated-Federated users are Dedicated users that federate against MyRack IdP using their organization credentials like ADFS. They have a dedicated:default role and “RAX-AUTH:federatedIdp”: “<url of something other than my.rackspace.com >”.
Note¶
Currently, Pilot also supports Datapipe portals. So please note that, the “Always shown” and “Always enabled” conditions in this document are only applicable to the Rackspace users and are not applicable to the Datapipe users.
Rackspace Logo¶
- Always shown
- Enabled unless user is a Datapipe user or a Dedicated user
- URL: https://portal.rackspace.com/[domain_id]/dashboard
Product Selection Dropdown¶
- Always shown
- Always enabled
Label & Active State¶
Label text shown when no application is selected is “Select a Product”
When the consuming control panel selects an active portfolio that is in this dropdown, the dropdown will gain the “active state” for the eyebrow (red underline) and the text for the selected portfolio item will show (e.g. Amazon Web Services) instead of “Select a Product” (http://docs.pilot.rackspace.net/custom-guide.html?highlight=portfolio#portfolio)
Currently portfolio sections that will highlight this dropdown: “Amazon Web Services”, “Dedicated Hosting”, “Google Cloud Platform”, “Mailgun”, “Rackspace Cloud”, “Rackspace Intelligence” (faws, gcp, intelligence, myrack, or rackspace-cloud – mailgun doesn’t use Pilot so it we didn’t add it to the values that will work)
Deprecated Control Panel Selector¶
If the selected portfolio item is ‘other’ (http://docs.pilot.rackspace.net/custom-guide.html?highlight=portfolio#portfolio) and there is a deprecated control panel selector label (http://docs.pilot.rackspace.net/custom-guide.html#control-panel-selector) then the Label text is the deprecated control panel selector label.
This functionality allows some applications that have not been kept up to date to show the correct Product Selection Dropdown text/hightlight. We would love to remove this functionality if all applications were to be updated to use the portfolio section.
Dropdown Items¶
- Amazon Web Services
- Always shown.
- Enabled unless user is MyRack-Dedicated
- URL: https://manage.rackspace.com/aws
- Google Cloud Platform
- Always shown.
- Disabled for MyRack-Dedicated and enabled for all others.
- URL: https://manage.rackspace.com/gcp/
- Dedicated Hosting
- Always shown.
- Enabled if the user is an account owner, federated, or not authenticated.
- URL:
- If MyRack-Dedicated: https://my.rackspace.com/portal/rs/[account_number]/home
- Other users: https://my.rackspace.com/
- Mailgun
- Shown if the user is not dedicated.
- Enabled if the user is the account admin or not authenticated.
- URL: https://mailgun.com/rackspace/sso
- Microsoft Azure
- Shown if the user has an azure role.
- Enabled unless user is MyRack-Dedicated.
- URL: https://manage.rackspace.com/azure/
- Rackspace Cloud
- Always shown.
- Always enabled.
- URL:
- If MyRack-Dedicated - https://my.rackspace.com/portal/rs/[account_number]/cloud/link
- Other users: https://mycloud.rackspace.com/cloud/home
- Rackspace Intelligence
- Always shown.
- Enabled if the user is not authenticated or has the monitoring role.
- URL:
- If MyRack-Dedicated: https://intelligence.rackspace.com/dedicated/entities
- Other users: https://intelligence.rackspace.com/
- Rackspace Managed Security
- Always shown.
- Always enabled.
- URL:
- If MyRack-Dedicated: https://security.rackspace.com/sso/myrack
- Other users: https://security.rackspace.com/sso
- VMWare Cloud on AWS
- Shown if the user has an ‘vmc’ role.
- Enabled unless user is MyRack-Dedicated
- URL: https://manage.rackspace.com/vmc
The following two products are only shown for Datapipe users and no other products listed above would be shown for them.
- Datapipe Cloud
- Only shown for Datapipe users
- Always enabled
- URL: https://cloud.datapipe.com/
- Datapipe One
- Only shown for Datapipe users.
- Always enabled
- URL: https://datapipeprod.service-now.com/
Impersonation Indicator¶
- Shown if the user is a Racker impersonating into a customer account (indicated by identity’s RAX-AUTH:authenticatedBy field).
- Also renders four floating borders around the edge of the viewport, so that there is always a clear visual cue.
Notifications¶
- Shown if the user is not a Datapipe user
- Always enabled
- Active highlight (red underline) when portfolio section is ‘notifications’ http://docs.pilot.rackspace.net/custom-guide.html#portfolio
- URL: https://portal.rackspace.com/notifications/
Tickets¶
- Shown if the user is not a Datapipe user
- Enabled when:
- Always for MyRack-Dedicated users (these users don’t have roles implemented like cloud users)
- If cloud, then only enabled if has one of Ticket:Admin, Ticket:Observer, Identity:user-admin roles
- When Disabled, clicking does not show dropdown
- Active highlight (red underline) when portfolio section is ‘tickets’ http://docs.pilot.rackspace.net/custom-guide.html#portfolio
Dropdown Items¶
- Ticket List
- Always shown
- Always enabled
- URL:
- If MyRack-Dedicated: https://my.rackspace.com/portal/rs/<account_number>/ticket/index
- Other users: https://portal.rackspace.com/tickets
- Create Ticket
- Always shown
- Enabled when:
- When user has ticketing role other than observer
- URL:
- If MyRack-Dedicated: https://my.rackspace.com/portal
- Other users: https://portal.rackspace.com/tickets/create
Support¶
- Shown if the user is not a Datapipe user
- Always enabled
- Active highlight (red underline) when portfolio section is ‘support’ http://docs.pilot.rackspace.net/custom-guide.html#portfolio
Dropdown Items¶
- Support PIN
- Only shown if the feature flag identity_customer_pin is turned ON.
- Shown for users who are not impersonating.
- URL:
- For MyRack-Dedicated: https://my.rackspace.com/portal/rs/<account_number>/user/show/<core_contactId>
- For Federated users: https://account.rackspace.com/users/federated/<user_id>
- Other users: https://account.rackspace.com/users/<user_id>
- Start a Chat
- Shown for users where the Support Service at the endpoint “/api/support-accounts/{tenant_id}/support-contacts” returns a chat team with a primary flag that has a button id
- Always enabled when shown
- Call <support number>
- Shown for users where the Support Service returns at least one valid phone number for customer
- Shows the primary support phone number for the primary support team for the customer in Support Service API (https://pages.github.rackspace.com/support-service/support-service/prod/)
- Not clickable
- View My Full Support Team
- Shown only for MyRack-Dedicated users
- Always enabled when shown
- Rackspace System Status
- Always shown
- Always enabled
- Support Documentation
- Always shown
- Always enabled
Billing¶
- Only shown for Datapipe users if “billing_available_for_datapipe” flag is turned ON.
- Shown for all other users.
- Enabled:
- Always for MyRack-Dedicated users
- For other users, then only enabled if user has one of Billing:Admin, Billing:Creator, Billing:Observer, Identity:user-admin roles
- When Disabled, clicking does not show dropdown
- Active highlight (red underline) when portfolio section is ‘billing’ http://docs.pilot.rackspace.net/custom-guide.html#portfolio
- URL:
- For dedicated customers (redirects to CBUI eventually): https://my.rackspace.com/portal/rs/<account_number>/cbuiBilling
- For Datapipe customers https://portal.rackspace.com/billing/datapipe
- For other customers https://portal.rackspace.com/billing/
Account¶
- Shown if the user is not a Datapipe user
- Always enabled
- Active highlight (red underline) when portfolio section is ‘account’ http://docs.pilot.rackspace.net/custom-guide.html#portfolio
Dropdown Items¶
- Account #
- Shown to authenticated users (when pilot doesn’t return a default header response)
- Clicking/Selecting text does not dismiss dropdown or navigate browser
- Service Level
- Shown when primary product in portfolio is ‘Rackspace Cloud’
- Account Settings
- Shown if user is NOT MyRack-Dedicated
- URL: https://account.rackspace.com/
- User Management
- Always enabled for Non-Federated Dedicated users.
- Disabled for Dedicated-Federated and Federated users.
- For other users, only enabled if user is admin or has roles Identity:user-manage.
- URL:
- If MyRack-Dedicated: https://my.rackspace.com/portal/rs/<account_number>/user/list
- Other users: https://account.rackspace.com/user-management
- Notification Preferences
- Shown for Cloud Admins, User Managers and all Dedicated users
- Not shown for federated users
- URL:
- For MyRack-Dedicated users: https://portal.rackspace.com/notifications/hybrid:<tenant_id>/preferences/
- For Cloud Admins and User Managers: https://portal.rackspace.com/notifications/cloud:<tenant_id>/preferences/
- Docs and Forms
- Custom Section from control panel
- If control panels sends along custom account dropdown items, they appear at the bottom of this menu
User¶
- Text:
- For MyRack-Dedicated users OR MyRack-Federated users: user’s email address (or ‘User’ if that does not exist)
- For all other Rackspace users: user’s username
- If the default header is shown (something went wrong with pilot’s requests to external APIs): ‘User’
- Can be overridden in payload: http://docs.pilot.rackspace.net/custom-guide.html#username
- Always shown
- Always enabled
- Active highlight (red underline) when portfolio section is ‘user’ http://docs.pilot.rackspace.net/custom-guide.html#portfolio
Dropdown Items¶
- My Profile & Settings
- Not shown for Datapipe users.
- Only enabled for Dedicated-Federated (Users who are Dedicated and Enterprise Federated), MyRack-Federated and Enterprise-Federated customers if feature flag ‘profile_and_settings_enabled_for_federated_user’ is turned ON.
- URL:
- For MyRack-Dedicated and Dedicated-Federated users: https://my.rackspace.com/portal/rs/<account_id>/user/show/<current_user_contact_id>
- For Enterprise-Federated and MyRack-Federated cloud users: https://account.rackspace.com/users/federated/<current_user_id>
- https://account.rackspace.com/users/<current_user_id>
- My Notification Preferences
- For Cloud and MyRack users only enabled if ‘notification_preferences’ flag is turned ON.
- Disabled for MyRack-Federated users.
- Not shown for Datapipe users, Unauthenticated users and for Enterprise federated users.
- URL:
- MyRack users: https://portal.rackspace.com/notifications/hybrid:<tenant_id>/preferences/mndf/
- Cloud users: https://portal.rackspace.com/notifications/cloud:<tenant_id>/preferences/mndf/
- Custom Section from control panel
- If control panels sends along custom user dropdown items, they appear in this location of the menu
- Datapipe users would see a custom user dropdown thats displays Datapipe Cloud and Datapipe One items
- Add a Login
- The switch_user_flow feature flag must be on for this to appear.
- URL:
- Default: https://login.rackspace.com/login
- Can be overrideen in payload: http://docs.pilot.rackspace.net/custom-guide.html#switch-user-flow
- Log Out
- Always shown
- Always enabled
- URL:
- Default: https://mycloud.rackspace.com/cloud/<DDI>/account/logout?logout_success=true
- Can be overridden in payload: http://docs.pilot.rackspace.net/custom-guide.html#logout