Microservices in the Brightspace Cloud



Download 120.79 Kb.
Page7/7
Date21.06.2017
Size120.79 Kb.
#21290
1   2   3   4   5   6   7

Hypermedia Proxy Service


Description

The Hypermedia Proxy Service acts as a proxy or mediator to learning paths within Brightspace platform.

Connections from the Hypermedia Proxy Service to Brightspace Learning Environment are made through the Brightspace Valence API.

Location

A global cluster that resides in AWS.



Dependencies

Landlord Service - If unavailable, this service will also be unavailable.

Depended on by Brightspace platform:

Activity Sequence Viewer



Data Transmitted/Stored

No data is stored alongside this service. The data passed through this service is:

OrgUnitId

For content modules and topics:

ID

Parent ID, child IDs, sibling IDs



Name

Completion state

Entity data representing files, links, LTI activity launch information, etc. Specifics depend on the entity type and are dictated by Brightspace Learning Environment.

Landlord Service


Description

The Landlord Service is a global microservice that supports multi-tenancy and Service Oriented Architecture (SOA)-based solutions. It provides each Brightspace instance with a TenantId, a permanent globally unique identifier.

Note If a Brightspace instance cannot connect to the Landlord Service, a unique TenantId is not assigned and any features that require a TenantId are unavailable. Users receive a message that their organization's system is not set up.

Location

A global instance that resides in AWS.



Dependencies

Depended on by:

Distributed Event Framework Service

Authentication Service

Brightspace Insights

Brightspace Data Platform

Brightspace Pulse

Data Stored

The TenantId.

The primary domain as well as any aliases of your Brightspace instance.

The main database split server as configured in the instance.config file and the database name.



API Calls

Landlord allows the following public read-only API calls:

Given primary domain, database server name, and database, retrieve a TenantId. All three values are required to get a TenantId.

Given a TenantId, retrieve the primary domain.



Provisioning a TenantId (on-premise clients only)

If you do not have a TenantId, submit a ticket to D2L Support requesting a TenantId with the following information for each of your sites:

the Brightspace site

the DNS CNAME, where the value is the database server name

name of the main database split

Important The DNS CNAME and name of the main database split must match the corresponding information in the instance.config file. The easiest method for providing this information to D2L Support is to copy the connection string element from instance.config for the main database split (excluding the password). For example:



Having your TenantID provisioned using a DNS CNAME instead of a host name ensures that if you need to make an unplanned change to your database server, applications that rely on the TenantId are unaffected. For example, if your site fails over to a mirror database, you update the CNAME value to the new host name. In this situation, no changes to the TenantID are required. For example, Name: LVUDB, Type: CNAME, and Value: winsql01.lvu.com.



Confirming that a TenantId has been provided (on-premise clients only)

As of 10.5.0, on-premise clients can check the ORG_ORGANIZATIONS table in their main database split to see if the TenantIdCachedForQueryString and CachedTenantId columns are populated for their org. If they are not populated, then Brightspace is unable to get the TenantId from the Landlord Service, meaning the TenantId is not provisioned yet or Brightspace cannot connect to the Landlord Service. The System Error Log should include a message that describes the issue.



Configuring Brightspace for the Landlord Service (on-premise clients only)

If your institution's firewall configuration does not allow outbound traffic, you must use one of the following methods to establish an outgoing HTTPS connection to https://landlord.brightspace.com (https://landlord.brightspace.com):

Add a firewall rule to allow outbound connections (port 80 and port 443) from all web and scalable servers to https://landlord.brightspace.com (https://landlord.brightspace.com).

Configure a proxy server on the network by setting up the following configuration variables:


d2l.System.Infrastructure.ProxyAddress - The address of the proxy server. It normally takes the form http://myproxy:8080/ or https://myproxy:8080/ where myproxy is the host name or IP address and 8080 is the port. d2l.System.Infrastructure.ProxyBypassAddresses - Addresses or address patterns that should not go through the proxy server. Address patterns take the form scheme://hostname:port/path where scheme is either http or https; hostname can be set as a * wildcard; port can be a specific number or a * wildcard to apply to all port numbers; and path is optional and can also contain a * wildcard.

Changes to TenantID values (on-premise clients only)

Features that require the Landlord Service could experience problems if the primary domain of the Brightspace site, the database server name, or name of the main database split changes.

If you need to change the primary domain of your Brightspace site, the database server name, or the name of the main database split, contact your D2L Technical Account Manager.

LMS Discovery Service


Description

The LMS Discovery Service provides a list of LMSs so users don't need to know their Brightspace instance URL. For example, when a learner uses Brightspace Pulse, they need to connect the app to a specific Brightspace instance. However, the learner may only know the name of the school and not the Brightspace instance URL. The LMS Discovery Service allows learners to enter the school name and the service provides them with the applicable Brightspace instance URL.



Location

A service that resides in AWS.



Dependencies

Depended on by Brightspace Pulse.



Data Stored

Institution names (currently only Higher Education, US/Canada)

Brightspace instance name and URL, if applicable (non-D2L institution names are also stored)

Approximate location of the institution (ZIP/postal code approximation)



How the Service Works

  1. From a device, a learner launches Brightspace Pulse for the first time and enters the name of their school. Brightspace Pulse contacts the LMS Discovery Service, which retrieves the Brightspace instance URL used by the school.

25.After entering the URL in Brightspace Pulse, the learner logs in, authenticating directly with the school’s Brightspace instance.

h:\continuous delivery\june 2016\microservices\12298.png

Figure : How the LMS Discovery Service works with Brightspace Pulse



User Info Service


Description

To enhance the performance and scalability of microservices that support Brightspace Pulse, the User Info Service acts as a proxy microservice responsible for:

Modifying or filtering user information between Brightspace Pulse and other sources of information (currently, Brightspace Learning Environment only).

Storing user preferences for Brightspace Pulse.

By default, the User Info Service is turned on and cannot be disabled.

Connections from the User Info Service to Brightspace Learning Environment are made through the Brightspace Valence API. To allow connections from the User Info Service to Brightspace Learning Environment, on-premise clients must ensure that the Brightspace Valence API is publicly accessible.



Location

A global cluster that resides in AWS. The User Info Service Database resides in IBM Cloudant.



Dependencies

No dependencies on other microservices.

Depended on by Brightspace Pulse.

Data Transmitted/Stored

The User Info Service stores the following user data for course offering enrollments in a User Info Service database in IBM Cloudant:

Composite key of tenantId and userId

orgUnitId

Org unit name

Org unit code

Org unit type

Color (Brightspace Pulse only)

Active flag (Brightspace Pulse only - was returned in previous enrollments, but is no longer returned)

Customized course names (edited in Brightspace Pulse)



Microservices and the Brightspace Data Platform


Description

The Brightspace Data Platform is D2L’s analytics solution. The Brightspace Data Platform stores raw events, and computes and stores aggregated data which can be accessed through an API.



Location

A cluster of nodes in AWS regions, influenced by our client base. D2L works with customers in many regions, jurisdictions, and markets with different needs and requirements for data privacy and residency.



Dependencies

Depends on the Distributed Event Framework Service.

Depends on the Caliper Gateway Service.

Depends on the Landlord Service.

Depends on the Authentication Service.

Depended on by Brightspace Insights.



Data Transmitted/Stored

The Brightspace Data Platform stores and transmits analytics events and aggregated data. Events provide information about actions performed by the user. For example, a content visit event is triggered when a user opens a content topic. These events are aggregated across meaningful dimensions, for example, course access by all students in a course. The aggregated data can be transmitted via the Data API, for example, to a Brightspace Insights report.

Events contain programmatic identifiers for the user, the context of the event, and the type of the event. For example:

A programmatic identifier for the user such as User ID = 123.

A programmatic identifier for courses such as Course ID = 987.

A programmatic identifier for the event type such as Login = 4545.

Stored data is encrypted with unique keys generated by D2L and are unique to each region. The data is stored on encrypted volumes to guard against back-end services being compromised. When transmitting data, the Brightspace Data Platform uses the HTTPS networking protocol. While in transit, all events are encrypted. Data access is restricted on a per-customer basis using the TenantID of the originating Brightspace instance. API access is governed by user and system-level permissions.

How the Service Works


  1. User events are generated in Brightspace Learning Environment. For example, when a user logs in to the system, a Login Event is generated.

26.The Distributed Event Framework Service sends events to the Brightspace Data Platform.

27.Events are stored in Brightspace Data Platform (BDP) Storage.

28.The Brightspace Data Platform aggregates data, and stores the aggregated data in BDP Storage. For example, Login Events could be aggregated along hourly, daily, and weekly dimensions.

29.Aggregated data is sent to Brightspace Learning Environment in response to API requests. For example, API requests could be used to generate a report showing the Login Events generated for learners in a course.



h:\continuous delivery\june 2016\microservices\29660.png

Figure : How microservices work with the Brightspace Data Platform




About D2L


A global leader in EdTech, D2L is the creator of Brightspace, the world’s first integrated learning platform.

The company partners with thought-leading organizations to improve learning through data-driven technology that helps deliver a personalized experience to every learner, regardless of geography or ability. D2L’s open and extensible platform is used by more than 1,100 clients and almost 15 million individual learners in higher education, K–12, healthcare, government, and the enterprise sector—including Fortune 1000 companies.

The company has operations in the United States, Canada, Europe, Australia, Brazil, and Singapore. www.brightspace.com (http://www.brightspace.com) | www.D2L.com (http://www.d2l.com)

Contact Us




Phone:

1.519.772.0325 (Worldwide)

Toll Free:

1.888.772.0325 (North America)

0.808.234.4235 (United Kingdom and Europe)

0.800.452.069 (New Zealand)

1.800.656.210 (Australia)

0.800.891.4507 (Brazil)

Fax:

1.519.772.0324

Email:

info@brightspace.com

Twitter:

@Brightspace

Web:

www.brightspace.com (http://www.brightspace.com) | www.D2L.com (http://www.d2l.com)

© 2016 D2L Corporation.

The D2L family of companies includes D2L Corporation, D2L Ltd, D2L Australia Pty Ltd, D2L Europe Ltd, D2L Asia Pte Ltd, and D2L Brasil Soluções de Tecnologia para Educação Ltda.

Brightspace, D2L, and other marks ("D2L marks") are trademarks of D2L Corporation, registered in the U.S. and other countries. Please visit d2l.com/trademarks for a list of other D2L marks.
Amazon Web Services and AWS are trademarks, registered trademarks or trade dress of AWS in the U.S. and/or other countries.

Apache, Apache Hadoop, and Hadoop are trademarks of The Apache Software Foundation. Used with permission. No endorsement by The Apache Software Foundation is implied by the use of these marks.

IBM and Cloudant are registered trademarks of International Business Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be trademarks of IBM or other companies. A current list of IBM trademarks is available on the Web at "Copyright and trademark information" at www.ibm.com/legal/copytrade.shtml (www.ibm.com/legal/copytrade.shtml).

All other trademarks are property of their respective trademark holders.




© 2017 by D2L Corporation. All rights reserved. untitled-1untitled-1untitled-1untitled-1


Download 120.79 Kb.

Share with your friends:
1   2   3   4   5   6   7




The database is protected by copyright ©ininet.org 2024
send message

    Main page