GC Enterprise Architecture/Playbook
This is a DRAFT COPY of the proposed GC EA Playbook. It is a work IN PROGRESS, and has not undergone any review.
INTRODUCTION - How to use the Playbook
This EA Playbook is intended to help Enterprise Architects build/manage their departmental Enterprise Architecture. The book is organized into chapters as per the B-I-A-T-S+P architecture layers called Plays. We recommend that users:
1. Read the Playbook all the way through first; and
2. Take an iterative approach to implementing the "Plays"
This Playbook is a living document, intended to evolve over time as the GC Enterprise Architecture teams grow and develop and as new solutions are introduced to the GC Enterprise Architecture landscape. Thus, your feedback would be greatly appreciated.
Please send any comments or suggestion for future updates to | GC EA CoP Collab Site
The Plays
A Business Architecture is where an organization identifies the various services that it suppose to provide externally, as well as the various functions it owns or needs to own internally to support the external service. In terms of GC Enterprise Business Architecture, this is where the Government of Canada identifies the various departments, the services they provide to Canadians and the functions they owns.
Fulfill the Government of Canada stakeholder's needs
As provider of service to Canadians, departments need to understand their stakeholders well. The stakeholders include their users, their partners (if any), their suppliers (if any), their program or project manager, their implementor, etc. Once you identify all your stakeholders, you need to identify their requirements and figure out how to make it easier for them to use your service, which means you need to really drill down your user interface design. This is what digital is all about, to make it easy for your users to consume your service.
While configuring your service, you should also take into account the policy requirements
- Clearly identify internal and external stakeholders and their needs for each business service including user centric design
To understand your stakeholder, it is recommended for program & project manager to conduct stakeholder analysis and create stakeholder mapping for each service being delivered. Users in this case can be Canadians (in terms of service your department provides), employees (if the service also applicable to your employees, or if your employees is the one implementing the service), or others. Partners can mean other departments or organizations that consume your service or provide data to you, or those who are building the system or building the program with you. Suppliers can be the SaaS companies who provide you with service, vendors, SSC, etc.
- Include policy requirement applying to specific stakeholder groups, such as accessibilities, gender based+ analysis, and official languages in the creation of the service
In identifying your stakeholder, ensure you are being inclusive, include other stakeholder groups.
- Model end-to-end business service delivery to provide quality, maximize effectiveness and optimize efficiencies across all channels (e.g lean process)
Architect to be Outcome Driven and Strategically Aligned to the Department and to the Government of Canada
- Identify which departmental/GC business services, outcomes and strategies will be addressed
- Establish metrics for identified business outcomes throughout the lifecycle of an investment
- Translate business outcomes and strategy into business capability implications in the GC Business Capability Model to establish a common vocabulary between business, development, and operation
Promote Horizontal Enablement of the Enterprise
- Identify opportunities to horizontally enabled business services and provide cohesive experience to stakeholders
- Reuse common business capabilities and processes from across government and private sector
- Publish in the open reusable common business capabilities and processes (in the Open Government portal) for others to develop cohesive horizontal enterprise services
Collect data to address the needs of the stakeholders
- Adopt a needs-based approach to data collection
- Do your data collection processes include an assessment of existing data assets (e.g. as documented in a data inventory and/or catalogue) to minimize redundancy and duplication?
- Collect only the minimum set of data needed to support a policy, program, service, or other function fulfill the business service
- Do you have a mechanism or process in place to ensure that all data collected can be tied to a specific business need (e.g. a policy, program, service, or other operational need) so that you are able to identify excess data?
- Reuse existing data assets and only acquire new data if required
- Do your data collection processes include an assessment of existing data assets (e.g. as documented in a data inventory and/or catalogue) to facilitate data reuse?
- Do you have a process or mechanism in place to assess and control the quality of existing data assets being considered for reuse?
- Do you have a process or mechanism in place to ensure that any reuse of existing data assets complies with privacy and other applicable laws and policies?
- Ensure your data collection methodology, including third party sources, yields high quality data
- Do you have a process or mechanism in place to assess and control the quality of data collected?
Manage data strategically and responsibly
- Define and establish clear roles, responsibilities, and accountabilities for data management
- Do you have a framework or policy that sets out your organization’s data governance structure? At a minimum, the structure would list key data roles in the organization (e.g. steward, custodian, analyst, scientist) and define the responsibilities and decision-making authorities associated with each of them.
- Identify and document the lineage of your data assets.
- Does your data inventory document any information about the lineage of existing data assets? If so, through what process is lineage determined and tracked over time? If not, is this information tracked anywhere else?
- Define retention and disposition schedules and perform regular disposition activities (I’m not sure about the last bit: are disposition activities necessarily regular and, if so, according to whose timetable? What is LAC’s GC policy on this?)
- Do you have a mechanism or process in place to ensure that retention and disposition schedules are determined (at least provisionally) for data collected? This is particularly relevant in the case of personal data, where timelines are set by the Privacy Act.
- Ensure information and data are managed to enable interoperability, reuse and sharing to the greatest extent possible within and with other across departments across the in government to avoid duplication and maximize utility, while respecting security and privacy requirements
- For what data domains and attributes have you developed reference and master data standards?
- To what extent does your organization adhere to existing enterprise-level standards for data?
- What is the percentage of data shared through information sharing agreements?
- To what extent is the data you share with other GC organizations interoperable?
- Do you have a process in place to evaluate whether a certain data need can be addressed by requesting data from a GC organization as opposed to collecting it?
- Contribute to and/or aligned to Enterprise Data taxonomy and classification structures to manage, store, search and retrieve information and data in all formats (I am uncertain about the reasoning here: is it to ‘manage, store, search, and retrieve’? It seems too broad to be relevant to architecture in particular.)
- For what data domains and/or attributes have you developed reference and master data standards?
- For what data domains and/or attributes have you supported the development of enterprise-wide data standards?
Use and share data openly in an ethical and secure manner
- Ensure data formatting aligns to existing enterprise and international standards. Where none exist, develop standards in the open with key subject matter experts, in consultation with the Enterprise Data Community of Practice.
- Data should be shared openly by default as per the Directive on Open Government and Digital Standards, while adhering to existing enterprise and international standards, including on quality or fitness for purpose.
- Do you have a process or mechanism in place to release data assessed for its public value?
- What is the percentage of collected and generated data assets that is released or made available to the public?
- Ensure that combined data does not risk identification or re-identification of sensitive or personal information
- Do you have a risk assessment process or mechanism in place to ensure that combining two or more datasets does not risk compromising the privacy and security of individuals by exposing sensitive or personal information?
Application Architecture consists of the interaction of applications with each other and with users. It focuses less on internal mechanics and specific programming and more on overall design on how data is consumed and created by the system. It views the interactions between applications, databases, middleware to ensure scalability, reliability, availability and manageability.
Use Open Source Solutions hosted in Public Cloud
While OSS is not a silver bullet several common misconceptions are used as arguments against Open Source software: A misconception with security is that with the code out of the eyes of the public that it prevents successful attacks and lowers liability, however in reality Security Best practices state that 'System security should not depend on the secrecy of the implementation or its components', and as Open Source development relies and hardening (or improving the security) of code it is often equal or more secure then proprietary solutions.
A misconception with support is that a support contract or license some how ensures that the proprietary system will receive improvements and patches, but in reality there is no obligation for a vendor to do so, while Open Source software survives by having a vibrant and helpful support community. Average resolution of issues are solved faster then in proprietary software by the very nature of crowd sourcing reducing the barrier of communication with a single entity or individual.
- Select existing solutions that can be reused over custom built
It is important to reduce the duplication of effort that has occurred due to segmented mandates, and increase collaboration and sharing across Departments and Agencies. Crown Corporations, Provincial and Municipal Governments as well as the Public at large who can benefit from new and innovative products and services based off of creations from the Government.
- Contribute all improvements back to the communities
Major benefits can occur not just from publishing the Software, but in developing Guidance the quality of software increases, while publishing Lessons Learned, White Papers and any other technical documentation can assist others in the future by providing templates and baselines.
For assistance in how to do this, you can view the TBS Guidance on Open Source Publishing.
Setting up shared teams for common problems where Developers from multiple departments can produce better solutions. Virtual Teams using open tools can enable rapid development in absence of collocation.
- Register Open Source software to the Open Resource Exchange
Scientific Innovation can occur from exposing Data to interested members of the activists, researchers, students and the public at large. Define Metadata for your application early in both English and French to support your release to Open Data. Development following the Government of Canada Standards on APIs can allow rapid uptake into Open Data feeds.
Use Software as a Service (SaaS) hosted in Public Cloud
- Choose SaaS that best fit for purpose based on alignment with SaaS capabilities
- Choose a SaaS solution that is extendable
- Configure SaaS and if customization is necessary extend as Open Source modules
Design for Interoperability
- Design systems as highly modular and loosely coupled services
Focus on smallest unit of purpose, and developing a single function. Ensure containers contain a single application, and build the smallest image possible.
Ensure containers are properly versioned and tagged.
- Expose services through APIs
Do not hide services under assumptions that someone would not find value in a service - often innovation can be bred from exposed services beyond it's original plan.
Follow the 'eat your own dogfood' mantra - in that all functionality should be a service that you consume.
Ensure that services are accessible via common methodologies, and follow the Government of Canada Standards on APIs.
- Make the APIs discoverable to the appropriate stakeholders
Follow DevSecOps Principles
- Use continuous integration and continuous deployments (CI/CD)
- Ensure automated testing occurs for security and functionality
- Include your stakeholders as part of DevSecOps process
Use Cloud first
- Adopt the Use of the GC Accelerators to ensure proper Security and Access Controls
- Enforce this order of preference: Software as a Service (SaaS) first, then Platform as a Service (PaaS), and lastly Infrastructure as a Service (IaaS)
- Fulfill Cloud Services through SSC Cloud Brokering Services
- Enforce this order of preference: Public cloud first, then Hybrid cloud, then Private cloud, and lastly non-cloud (on-premises) solutions
- Design for cloud mobility and develop an exit strategy to avoid vendor lock-in
Design for Performance, Availability, and Scalability
- Ensure response times meet user needs, and critical services are highly available
- Support zero-downtime deployments for planned and unplanned maintenance
- Use distributed architectures, assume failure will happen, handle errors gracefully, and monitor performance and behaviour actively
- Establish architectures that supports new technology insertion with minimal disruption to existing programs and services
- Control Technical Diversity - design systems based on modern technologies and platforms already in use
5. Security and Privacy Architecture
Build Security into the Full System Life Cycle, Across All Architectural Layers
- Identify and classify risks associated to the service’s business objectives, goals, and strategy
- Design security measures according to business and user needs, risks identified, and security categorization of the information and assets; integrate security across all architectural layers (BIAT)
- Design systems to not be susceptible to common security vulnerabilities; resilient and can be rebuilt quickly in the event of compromise; and fail secure if the system encounters an error or crashes
- Ensure that data received from external parties is profiled and validated prior to its use
Ensure Secure Access to Systems and Services
- Identify and authenticate individuals, processes and/or devices to an appropriate level of assurance before granting access to information and services
- Constrain service interfaces to authorized entities (users and devices), with clearly defined roles
- Make use of modern password guidance, and prioritizing length over complexity, eliminating expiry, and blacklisting common passwords
Maintain Secure Operations
- Integrate aggregate outputs from security assessment and authorization activities into security architecture lifecycle processes, to ensure reference artefacts remain relevant and valid
- Design processes to operate and manage services securely, and continuously monitor system events and performance in order to detect, prevent, and respond to attacks
- Establish processes to monitor security advisories, and apply security-related patches and updates to reduce exposure to vulnerabilities. Apply appropriate risk-based mitigations when patches can’t be applied
Privacy by Design
- Perform a privacy impact assessment (PIA) to support risk mitigation activities when personal information is involved
- Implement security measures to assure the protection of personal information
- Take into consideration the 7 Foundational Privacy Design Principles when designing services