|
|
| (46 intermediate revisions by 11 users not shown) |
| Line 1: |
Line 1: |
| '''CURRENTLY EDITING IN ETHERPAD. SEE #fedora-cloud on Freenode to coordinate.'''
| |
| {{header|cloud-sig}} | | {{header|cloud-sig}} |
| Fedora Cloud Product Requirements Document.
| | <!-- The code for this page is kept at https://pagure.io/cloud-sig/blob/main/f/PRD.mw and should be edited and merged from there --> |
| = Document Purpose and Overview =
| | = Purpose and Demographic = |
| == What this document describes ==
| | The ''Fedora Cloud Edition'' allows users to work across multiple virtual environments at |
| This is the [http://en.wikipedia.org/wiki/Product_requirements_document wikipedia Product Requirements Document] for the Fedora Cloud SIG. It:
| | scale by focusing engineering efforts on supplying a base disk images, rpms, and |
| * Provides a high-level market of the cloud computing market as it pertains to the Fedora Cloud SIG; this includes overviews of things which may not be within our actual scope/ability to accomplish at the current time.
| | container-based tooling of various architectures for working in and around public and |
| * Provides deeper understanding of the types of users who could use Fedora for their cloud computing needs. This includes describing their main day-to-day tasks, common problems, and so on. The perspective here is not necessarily limited to system administrators, or developers, but a combination of many types of users and roles.
| | private cloud environments. The ''Cloud Edition Working Group'' targets efforts towards the |
| * Ties common issues and needs of potential users and consumers of the Fedora Cloud product to high-level product needs, from a "functional" standpoint
| | facilitation and improvement of continuous delivery by ensuring that Fedora project |
| * Provides solutions, in the form of "changes" or "features" which will provide the functionality described as needs for the potential users.
| | solutions support cloud native workflow without forcing users to understand all of the |
| = Release/Product Overview = | | environments in which they require enablement. |
| Fedora Cloud provides a customizable base image and tools for developing scale out applications on public and private clouds, as well as two to four number of images pre-configured for what we expect to be the most popular scenarios/use cases for using Fedora for cloud computing. | | |
| Public and private cloud adoption is taking off, and the requirements for an image OS differ significantly from the requirements for a desktop or server OS. In these environments, much or all of the instance lifecycle — from the creation of the image and addition of software or configuration specific to the instance, to the teardown of the image — will be automated. Systems are designed to scale out via many identical nodes rather than scale up with carefully-tended individual servers. Individual uptime (mean time between failure) is not as important as the ability to get a new instance running quickly (mean time to recovery).
| | = Product Objectives = |
| With that in mind, we're tailoring a release specifically for cloud environments.
| | == The Fedora Cloud Base Image == |
| == Market Opportunity ==
| | There are many requirements for building and deployment into the various options for |
| Public and private cloud adoption is happening rapidly, but the market is not yet mature and is relatively ripe for disruption even though some favorites have emerged as early leaders.
| | private and public clouds. The primary goal for the Cloud Edition is the Fedora Cloud Base |
| In the next two to three years, we expect to see a great deal of growth in adoption and still see a number of emerging players where no clear favorites have emerged (for instance, Google Compute Engine). Additionally, some platforms (Amazon Web Services) have matured to a point where a large number of companies are relying upon the technology for their full infrastructure. While this is not a widespread practice, AWS is seeing a great deal of adoption and will likely start eating into "traditional" workloads that currently live behind the firewall.
| | Image. The Cloud Base image provides disk images for all of the environments that can be tested |
| In short, there's an enormous opportunity for Fedora to become an instance-OS of choice if the project moves quickly, develops or adopts the right technologies, and succeeds in educating the market about its existence. A failure on any of those three points means that the Fedora Cloud product will have little chance in taking a significant portion of the new market or taking any of the existing market.
| | and confirmed to be functional. It is foundational to additional configurations and |
| === Major Release Themes === | | initiatives that require an image-based deployment model. |
| Cloud computing in general is the transition of computing power from individual hand-tended resources to a ubiquitous utility. Fedora fits in at several levels, from the infrastructure service software we include (like OpenStack and Eucalyptus) to end-user tools.
| | |
| The Fedora Cloud image fits into middle of this, providing a guest OS image to run on Infrastructure as a Service systems, on which platform and application services can be deployed. We targets use cases which fit the "cattle" side of the "pets vs. cattle" metaphor for computing.
| | == Adaptations for Hyperscaler Use Cases == |
| === Secondary Objectives ===
| | Some use cases may be considered as antithetical to the goals of other edition deployment |
| Aside from adoption and development of applications on top of the Fedora Cloud images, we have a few secondary goals that will be helped by wider adoption:
| | models, but have a strong use case to be included by default in hyperscalers. The use of |
| * More testing of Fedora images with additional bug reports.
| | cloud-native components is continually evolving and highly opinionated, so there is added |
| * Better feedback about how the product should improve. This is separate from "bug reports" in that we hope to engage the audience and receive detailed feedback about use cases, desired features, developing trends in cloud management, etc.
| | benefit to including these curated images for use in the exploration of new technologies |
| * Patches and contributions that will help improve the product, and Fedora in general. As we are increasingly successful, more users will take an interest in helping to develop our product.
| | and scientific reproducibility. |
| == Target Market / Audience == | | |
| Developers creating scale out applications on top of public and private clouds, and organizations and users running those applications. FIXME (this could use another sentence? or if you think it is both beautiful and sufficient, feel free to just delete this FIXME)
| | At the 2020 Power Management and Scheduling in the Linux Kernel summit (OSPM)[1], Andrea |
| == Delivery Mechanisms ==
| | Righi and Rafael Wysocki discussed the use of hibernation on cloud-based systems and |
| Cloud images images must be easy to consume as part of a pulbic or private cloud. Because we target these environments, we won't be worrying about physical media at all. The cloud images also won't be "installed" in the same manner that users are accustomed to with desktop or server images. The cloud image will simply boot in its target environment ready to run, or for further customization and configuration via a boostrapping service.
| | reviewed work that they have done in support of the program. Jonathan Corbet points out |
| === Where to obtain ===
| | that "[t]he value there is to be able to pause a workload to save money. For example, |
| Users will be able to obtain the images for public clouds via download ''or'' via the usual marketplace for those images. For instance, we publish Amazon AMIs on Amazon directly. Users are able to launch new instances with Fedora without having to obtain the images directly from the Fedora Project and then upload to Amazon.
| | Amazon's ''spot instances'' run at low priority when there are spare resources available; |
| Users will be able to download appropriate images for Apache CloudStack, Eucalyptus, OpenStack, OpenNebula, and other IaaS platforms.
| | they can be shut down with ten minutes notice at any time." With support from the Cloud |
| === Delivery Format ===
| | Edition team, the agents and kernel support can be maintained consistently and |
| Images will be delivered as AMIs on Amazon EC2, and as downloadable images in qcow2 and raw.xz formats. We may add other public cloud images and other downloadable formats to meet demand or anticipated need.
| | reliably. |
| === Updates ===
| | |
| Fedora Cloud images can be updated using yum as normal. We also intend to produce periodic respun images with security updates, once the infrastructure is in place to support that.
| | There are a number of example use cases to explore in both traditional and non-traditional |
| === Image Creation Toolkit ===
| | ways and some of them are included in the next section. This use cases section is intended |
| We will also maintain a set of tools that can be used to generate, modify, and configure Fedora instances for use with public and private clouds. Initial efforts will focus on creating official images in Fedora's build system. This effort is in parallel to that and does not block the main release. The Fedora Cloud SIG is also interested in a curated library of image templates.... FIXME BLAH BLAH BLAH
| | to be updated as time goes on to identify specific initiatives and configurations that the |
| == Measuring Success ==
| | Cloud Edition can support. |
| Currently, Fedora is not a widely used option for instances on public and private clouds. We know there's some usage, but it's not one of the top three or four OSes on Amazon or (likely) for private clouds.
| | |
| Success looks like:
| | == Example Use Cases == |
| * Increase in adoption.
| | === An Example: Base image for use with Cloud IDE === |
| * Third party support / targeting of Fedora Cloud as a platform.
| | The use of Fedora as a foundation for IDE environments such as the Amazon ''Cloud9'' IDE |
| * Increased contribution and participation in the Fedora Cloud WG and Fedora Project in general.
| | requires curation and support. When it is not properly prepared, it cannot be included as |
| = User Profiles, Goals, and Primary Use Cases =
| | a part of the product offerings available to users who might wish to use them. A curated |
| FIXME: Still working out some logic on this section. But forging ahead with what I have for the moment.
| | package group is beneficial, but insufficient for Amazon service teams to trust that there |
| Goal of this section is to provide insight into either or both of:
| | will be continued support. The Cloud Edition is consistent with other Fedora Editions, but |
| * Primary Use Cases: What are the situations / environments in which we expect a Fedora Cloud Product to be used
| | includes some active modifications to ensure support for next-generation technologies that |
| * User Profiles and Goals: This is more like “personas” work, or could be done as “user stories” (more along the lines of agile, see http://en.wikipedia.org/wiki/User_story )
| | would not be possible with systems intended to be more consistent with downstream |
| ... and then ensure that for each type of user or use case, we have features/changes that make the Fedora Cloud product useful.
| | directives. |
| == User Profiles == | | |
| FIXME: -- integrate this list, make pretty-sounding paragraph to introduce it
| | === An Example: Base Image optimized for use with cloud native Kubernetes services === |
| Three Cloud User Roles (based on “Description and Application of Core Cloud User Roles” ACM CHIMIT 2011, December 4 2011) that describe the tasks of the people who interact with any cloud-based Information Technology system:
| | Amongst the hyperscaler cloud infrastructures there are those services where a specialized |
| # Cloud Service Creator: Develop the technical and business aspects of a (simple or high-level) cloud service
| | internal community is served. One for which the standard Fedora Editions does not include |
| # Cloud Service Provider: Provide all types of services (SPI, etc.) to a Service Consumer
| | specialized support. Optimizing images for use with downstream platforms, i.e. not OKD or |
| # Cloud Service Consumer: Consume all types of services (SPI) offered by a Service Provider
| | Red Hat OpenShift, for managing containerized workloads the cloud images can be for |
| FIXME/SUGESTION -- move persona details to separate document, and simply summarize them here with a title and two points each -- see server PRD.
| | example, Kubernetes (k8s): Support for k8s is,in all cloud providers, an opinionated |
| === Persona #1: Alan the AWS enthusiast ===
| | configuration that fits specifically an immutable operations model. |
| Alan was a very early AWS adopter. He writes and maintains a number of AWS-deployed applications, including staging and production, from the same data source. He needs to monitor his applications for cost, resource consumption, demand peaks and any crashes. He works for a small start-up. Puppet master.
| | |
| By-line: FIXME
| | === An Example: (EDA) Electronic Design Automation === |
| * Adoption curve: Innovator
| | EDA workloads typically target their support towards stable, downstream EL distributions |
| * Skills: Experienced web developer & operations guy - not on his first cloud application architecture, mastery of continuous integration (CI) and continuous delivery (CD).
| | and are therefore not capable of moving as quickly as distributions like Fedora. With the |
| * Behavior patterns: Wants to concentrate on application development, not architecture. Change management - applying security updates to guest systems - takes a chunk of his time. He spends a little time every few months evaluating the cloud architecture to consider alternative components to increase price/performance.
| | use of cloud-native technologies, it's clear that the design world is at last ready to |
| * Goals: To deliver excellent scalable web-deployed applications with a web interface and robust API for a mobile application front-end. To deliver incremental, tested updates to the applications on a regular basis.
| | engage agile processes for the development of system-on-chip (SoC) design. The electronic |
| * Needs: Application lifecycle management, monitoring, to make his apps faster. Makes heavy use of cloud APIs and services to minimize work he has to do setting up his own services.
| | design automation (EDA) industry is maneuvering itself into position that makes new |
| * Main Tasks: Writing and deploying code. Anything that requires a significant distraction from that is a time sink, and Alan has little tolerance for mucking with infrastructure more than he has to.
| | technologies critical to decreasing time to market. Almost all of the pieces to facilitate |
| * Attitudes: Alan loves AWS. He's unlikely to consider an alternative public cloud due to dependencies on AWS services and the fact that migration would consume too many cycles that he doesn't have.
| | an SoC methodology are in place in terms of cloud-managed development tools. The industry |
| * Beliefs: Continuous deployment is king. Automate all the things. Do the hardest things often, until they’re easy. etc.
| | open access model is an ideal dovetail to ensure that the Fedora Cloud Edition can be a |
| * Motivations: getting the code running in production
| | target for early development and adoption of advanced technology. |
| * Frustrations: poor command line tools,
| | |
| * Environment: Macbook for development, AWS for development, testing, and production environments.
| | For EDA, there is an expectation that a significant number of applications will run |
| * Interface Usage Tendencies:
| | generally in the same operating space. Additionally as function specialization occurs, it |
| ** GUI: Medium
| | will be beneficial to have an engineering specialization in tailoring these specialized |
| ** CLI: Medium
| | operating systems to the requirements of software-defined architecture. |
| ** API: High
| | |
| * Collaborates With: Alan is pretty much working alone. He may work with other folks in the start-up, but not on a daily or regular basis. His work flow is tooled specifically for his convenience.
| | == Focus on the familiarity of the users. == |
| === Persona #2: Erin the Rails devops team member ===
| | There are many people who have not advanced to the level of using container-based models |
| Erin uses the cloud to do Ruby on Rails development utilizing virtual machines. She works as part of a DevOps team responsible for all aspects of a set of applications.
| | for their bespoke code or operations practices. We don't want to leave them |
| FIXME more about Erin
| | behind. Furthermore, there are still established practices which can only support |
| By-Line: FIXME
| | containerization in part. Supporting these transitional and hybrid models is the focus of |
| * Adoption curve: Early adopter
| | the Cloud Working Group.are looking at ways we can build support for next-generation |
| * Skills: Familiar with Linux systems. Several years' programming experience, comfortable with Linux and other environments.
| | support models. |
| * Behavior patterns: Will choose from the range of available flavors of VMs to run. Will use OpenStack images to launch instances, also create and save her own.
| | |
| * Goals: To set up and use cloud guests for her application with minimal effort. Erin is focussed on the application and regards the IaaS services as resources to be used with a minimum of administrative overhead. Would prefer if her language stack were just there and just worked in the cloud guests of her choice.
| | Many users of applications software have decades of experience interacting with a base |
| * Needs: Easy way to create cloud guests configured with the versions of Ruby and Rails used for her various projects.
| | operating system standard actions. They may not yet be able to move their practice to an |
| * Main Tasks: Deploying and updating code in development, testing, and production environments. Maintains the guest images used as a base in all three.
| | immutable OS model or use projects that abstract away from decades of \*nix software |
| * Attitudes: Hates it when things change just for change's sake. Wants the latest of the things her team needs, wants the rest
| | development models. |
| * Beliefs: The development, test, and production enviroments need to be identical.
| | |
| * Motivations: provisionning environments quickly and easily
| | == An established practice for investigating the best model for deployment and governance == |
| * Frustrations: lacking guest images preconfigured with her application framework
| | In many cases, cloud providers may determine that their opinionated model is the best or |
| * Environment: Linux development system. Primarily launches cloud instances via the OpenStack GUI. Part of a devops team which manages the a small OpenStack deployment for their own use. Some else in her group has primary responsibility for managing the IaaS layer, but she can pitch in with a basic understanding if need be.
| | singularly valid model. This may be the result of focused groups or Product Managers who |
| * Interface Usage Tendencies:
| | do not have a familiarity with the possiblities of incorporating open source into their |
| ** GUI: Medium-High
| | active process due to concerns of any sort. It is a function of the cloud working group as |
| ** CLI: Medium
| | curators of the edition to actively explore these management models and software decisions |
| ** API: Low
| | as a method to either determine the best of class open source interaction or to identify |
| * Collaborates With: Other members of her development and production operations team.
| | in a way that is acceptable to the greater Fedora community exactly why the current model |
| === Persona #3: Walter the Web Developer ===
| | is not handled in an [https://www.theopensourceway.org/ open source way]. |
| Walter develops feature rich HTML5 applications using Symfony and Twitter Bootstrap, and a range of other web technologies. He has no real system administration skills, and develops on a single desktop computer or his MacBook. Walter wants the app to Just Work when he’s finished, and doesn’t really think a lot about caching, sharding, proxies, or making his app scalable. He works in a medium sized development shop which has people who take care of deployment and change management to the web applications he produces.
| | |
| By-line: “Not a bug: Works for me”
| | Examples of opinionated models are the use of python 2.7 in Google's gcloud sdk or the practice |
| * Adoption curve: Early majority (Early adopter for web technologies)
| | of clobbering the systemd-acpid \`sleep.sh\` file in the Amazon Hibernation Agent. Simply |
| * Skills: PHP, Ruby, Python, Javascript, CSS, multiple MVC frameworks, experienced Linux & MacOS X user (but not admin), comfortable setting up LAMP, github.
| | put, these are problems for the Cloud Edition to resolve and to help work with the |
| * Behavior patterns: Wants to concentrate on application development, not architecture. Spends most of his time in TextMate, and testing how app behaves and looks in VirtualBox.
| | upstream teams responsible to make their applications functional in the context of the |
| * Goals: To deliver excellent web applications and robust RESTful API for mobile apps.
| | Fedora Distribution and downstream Enterprise Linux. |
| * Needs: Up to date application development stack, good developer tools, someone to actually deploy his app.
| | |
| * Main Tasks: FIXME
| | As a part of the working group, this team builds, monitors and improves the upstream |
| * Attitudes: Walter would like to know more about the cloud but there’s so much to learn, he has no real idea where to start, and just keeping on top of new web development trends takes all his research time.
| | experiences complicated by closed or non-standard models to ensure that there is a path |
| * Beliefs: FIXME (is this right?) “This stuff should be easier to get a handle on.”
| | forward to remove the barriers that block open source success for the cloud communities to |
| * Motivations: FIXME
| | which we are aligned. |
| * Frustrations: FIXME
| | |
| * Environment: Macbook for development, a Linux desktop for test deployment, VirtualBox for testing on different browsers.
| | = Architectural Considerations = |
| * Interface Usage Tendencies:
| | == Boot Support == |
| ** GUI: High
| | * Legacy Bios or ''Classic Boot'' |
| ** CLI: Low
| | * UEFI |
| ** API: Low
| | |
| * Collaborates With:
| | The Boot support is dependent upon a number of other considedations. Neal Gompa's collaborative work with the Red Hat team has made our images ready for both without modification. Aarch64 is UEFI only. |
| === Persona #4: Martina the Senior Sysadmin ===
| | |
| Martina is a senior systems administrator at a large university. She has to manage more systems than she really has time for, and much of her time is interrupted by requests from grad students and other members of the university for resources. The IT department has some automated systems for deploying new sites with Drupal, Wordpress, MediaWiki or the like, but it needs to be done by hand. Martina's group has recently deployed an OpenStack environment, allowing some groups to provision virtual machines by themselves. This is some help, but is a level too low to take care of most users' real needs. She's interested in taking this one step further and providing a full Platform as a Service offering.
| | == Processor Architecture Support == |
| By-line: "I could automate this, if I weren't so busy."
| |
| * Adoption curve: Early adopter
| |
| * Skills: Shell scripting expert, hacks at Python, Perl, and just about anything else. Good at putting all the parts together.
| |
| * Behavior patterns: Would like to work on interesting emerging technologies that she believes will really help her employer and her users, but keeps getting interrupted by break/fix and user help requests.
| |
| * Goals: Provide a self-service application infrastructure for users.
| |
| * Needs: Robust deployment tools, simple automation stack, ability to rapidly provision large number of hetergenous systems at once, and then efficiently monitor and change them.
| |
| * Main Tasks: Provision new systems on both the public cloud and the private OpenStack cloud her company runs. Work with developers to deploy code as often as possible.
| |
| * Attitudes: FIXME
| |
| * Beliefs: “Whenever a sysadmin has to interact with a user directly, something has gone wrong”
| |
| * Motivations: FIXME
| |
| * Frustrations: FIXME
| |
| * Environment: Fedora on her desktop, Android on a phone
| |
| * Interface Usage Tendencies:
| |
| ** UI: Low
| |
| ** CLI: High
| |
| ** API: Medium-Low
| |
| * Collaborates With: Developers, junior administrators, CTO, finance organization
| |
| === Persona #5: Sarah the Data Scientist ===
| |
| Sarah is a data scientist in a biotech startup. She works with large data sets and intends to
| |
| process them with map-reduce. She plans to test this in her office and then scale out to
| |
| local cloud resources and to spot instances in Amazon EC2
| |
| By-line: "Crunching a large set of data, get it done and done efficiently"
| |
| * Adoption curve: innovator
| |
| * Skills: Python, Scala, Octave, R, Hadoop, Cassandra, and Pig.
| |
| * Behavior patterns: Most interested in results, but not afraid of tackling new technology to get there.
| |
| * Goals: Process data quickly and efficiently, at the lowest cost possible. Since Sarah is potentially working with medical data, she cares about data strorage, retention policies, and ethical issues around her data - not just reliability and cost.
| |
| * Needs: Reliable images with the latest improvements in her toolchain. Does not want to compile her own Hadoop, Pig, Mahout, etc.
| |
| * Main Tasks: collecting/crunching data, creating visualizations from data, managing data storage/retention.
| |
| * Attitudes: she cares about performance and is energy-conscious. Cares about security and the ethics of data management.
| |
| * Beliefs: "The tools are only a means to discover interesting scientific and user data"
| |
| * Motivations: FIXME
| |
| * Frustrations: FIXME
| |
| * Environment: Fedora on her workstations, CentOS servers in the data center (including an OpenStack deployment), uses public clouds like Rackspace, the HP cloud, or AWS spot instances to spin up many servers at once for a short period of time, a Mac laptop
| |
| * Interface Usage Tendencies:
| |
| ** GUI: Medium
| |
| ** CLI: Medium
| |
| ** API: Medium
| |
| * Collaborates With: Other researchs and scientists, lab technicians, HPC techs, more 'pure' developers
| |
| === Persona #6: Jody the HPC Scientist ===
| |
| Jody is a researcher at a major university. She previously used grids to solve meteorological simulations using
| |
| batch schedulers (SGE, Torque). Since she needs to run many parallels simulations, she thinks about using cloud ressources for temporary infrastructure overflow.
| |
| By-line: "I need a bunch of machines to run my computational tasks, cloud or not."
| |
| * Adoption curve: Early majority
| |
| * Skills: Shell, Python, Fortran
| |
| * Behavior: Most interested in results, but not afraid of tackling new technology to get there.
| |
| * Goals: Run her computational tasks
| |
| * Needs: access to distributed filesystems (NFS, GlusterFS)
| |
| * Main Tasks: Designing experiments and running them
| |
| * Attitudes: She is not a computer nerd, but someone who likes to get things done
| |
| * Beliefs: "The tools are only a means to validate my theories and give them real-life applications"
| |
| * Motivations: FIXME
| |
| * Frustrations: FIXME
| |
| * Environment: Fedora on her lab workstations, CentOS servers in the university data center (including an OpenStack deployment), uses public clouds like Rackspace, the HP cloud, or AWS spot instances to spin up many servers at once for a short period of time, a Mac laptop
| |
| * Interface Usage Tendencies:
| |
| ** GUI: Medium
| |
| ** CLI: Medium
| |
| ** API: Medium
| |
| * Collaborates With: other scientists, few research engineers (sysadmin or developers)
| |
| == Primary Use Cases ==
| |
| === Web Application Deployment in a Public Cloud ===
| |
| Modern web applications are deployed as a collection of interconnected
| |
| services, including parts like web servers, application servers,
| |
| databases, and caching layers. Fault tolerance is handled at the overall
| |
| orchestration level rather than by individual instances Fedora Cloud can
| |
| be the base of each of these parts, providing recent libraries, server
| |
| software, and language toolchains. Each system will be managed using the
| |
| public cloud's own management tools plus a configuration management system
| |
| like Puppet, Chef, Salt, or Ansible.
| |
| === Web Application Deployment in Private Cloud ===
| |
| As above, but in a locally-deployed and managed private cloud system.
| |
| === Web Application Deployment in Hybrid Cloud ===
| |
| As above, but rather than a single cloud provider, the application
| |
| seamlessly takes advantage of resources in both a private and public
| |
| cloud.
| |
| === Big Data / Number-Crunching ===
| |
| Deploy scale-out application for data processing to public, private, or hybrid cloud.
| |
| FIXME: more?
| |
| === Docker Container Host ===
| |
| FIXME: merge this into technogloy agnostic "simple deployment from dev to prod"
| |
| Docker is a technology for running applications inside a protected
| |
| container. These containers run under the host kernel, but otherwise
| |
| are self-contained. The Fedora Cloud image running in either a private
| |
| or public cloud can provide the host level, including basic docker
| |
| management tools plus tools for security and for access to storage.
| |
| Workflow may involve developing and testing Docker containers on
| |
| local system and pushing to cloud for production.
| |
| === OpenShift Origin System ===
| |
| FIXME: make this tech-independent -- basis for PAAS. (OpenShift can be mentioned, but these should be problem-focused.)
| |
| OpenShift Origin is an open source platform-as-a-service system already included in Fedora.
| |
| A Fedora Cloud image focused on OpenShift would make it easy for users
| |
| to run their own PaaS.
| |
| === Simple Deployment of code to from Development to Production ===
| |
| As a developer, I want to ensure that my code is easily deployable from my development environment to a QA environment and finally a production environment, without encountering compatibility issues or surprises from differences in the environment.
| |
| === Development as Part of a Team ===
| |
| As a member of a development team, I would like to develop in an environment where code can go through unit or functional testing, and be approved or accepted by other members of the team.
| |
| Example: A feature described as “Continuous Integration platform” may be listed in the Features section, and the various tools available to implement would be enumerated and described in the “non-functional requirements” section, and cross-coordinated with the server working group.
| |
| FIXME/note I (mattdm) don't think we're ready for this one -- it's more involved than the other things we are tackling. maybe after the first release?
| |
| === Development using Software not included in the Distribution ===
| |
| FIXME -- do we want to mention using software stacks _in_ the distribution first?) As a developer, my toolchain includes libraries or dependencies on other packages using libraries not in the Fedora distribution, and I may be developing for distributions not limited to Fedora.
| |
| Example: A feature described as “Portable code” (REALLY POOR DESCRIPTION, sorry) FIXME may be listed in the Features section, and “Software Collections” might be listed as a requirement.
| |
| Note that this may have some cross-over with a possible additional story/use case, “Deployment of code using libraries not included in the distribution.” FIXME (clarify? remove?)
| |
| = Target IaaS environments =
| |
| The Fedora Cloud product can be used as a guest/VM/image under many IaaS services and providers. For projects that are not currently packaged within Fedora/EPEL, we may need to locate a kind person to ensure testing. These include:
| |
| Open source IaaS systems:
| |
| * OpenStack
| |
| * Eucalyptus
| |
| * Apache Cloudstack
| |
| * OpenNebula
| |
| * oVirt
| |
| Public clouds:
| |
| * Amazon EC2
| |
| * Google Compute Engine
| |
| * HP Cloud
| |
| * Rackspace
| |
| * Digital Ocean
| |
| * Linode
| |
| = Features =
| |
| FIXME: this is documentation for us as PRD writers. Remove once the feature section is in better shape. :)
| |
| Features here address the primary and secondary use cases, product or secondary objectives, market opportunities from above.
| |
| Features should provide functional requirements (“what it should do”) preferably in a narrative fashion - more of a story / solution description, rather than “package XYZ” - the features (the ways to meet a user's objectives?) each likely consist of more than one package/enhancement, and those packages should be detailed in the “Detailed requirements” section of this document, and each of those detailed requirements should refer back to which feature it supports.
| |
| == Feature #0 ==
| |
| Feature description should be described in the line saying “Feature #1/2/etc.”.
| |
| Describe the feature in more detail, specifically addressing how it addresses user scenarios, primary or secondary use cases / objectives of the product.
| |
| Use a table to indicate the following items:
| |
| Priority (Must, Should, NTH)
| |
| Citation of use cases addressed
| |
| As work continues and specific detailed requirements are developed, reference the detailed requirements within this document helping to fulfill this feature. This helps to ensure awareness around “do we still have a feature if some of the detailed requirements are not fulfilled, and thus are not able to address the specific use case needs / user objectives.”
| |
| == Feature: Ready to run in Public and Private Clouds ==
| |
| The Fedora cloud image is ready to go out of the box in the public and private cloud environments we target. It includes cloud-init, the defacto standard for boot-time configuration for cloud instances, and the client provisioning tools for OpenStack Heat.
| |
| == Feature: Ready Access to Fedora Collection of Packages ==
| |
| SUPER FIXME
| |
| * normal packages
| |
| * language and application stacks to enable whatever you need... blah blah blah FIXME
| |
| * different versions of languages through Software Collections
| |
| * other technologies as they are developed and integrated
| |
| == Feature: Docker support ==
| |
| Docker is an easy to use interface for running application containers on Linux. Fedora is uniquely positioned to provide the best platform for Docker, since this container technology is not a security solution, but can be made reasonably secure when wrapped with SELinux. This includes adding libvirt support to the image, which is more heavyweight than many users of the image for other purposes will want, so we will produce a dedicated image specfically tailored for Docker.
| |
| == Feature: Big Data Tools ==
| |
| FIXME ... Exact contents in collaboration with Big Data SIG ....
| |
| == Feature: Cloud -> Server ==
| |
| The Fedora Server product targets more traditional server roles, where systems have a more unique identity. The Fedora Cloud image supports this by providing a path to go from our base to a Fedora Server role, in effect taming one of your cloud computing "cattle" and making it into a "pet" traditional server — but running in a cloud environment.
| |
| = Requirements =
| |
| ''''' FIXME TODO: change these things into actual requirements in the lovely format shown below.'''''
| |
| * Support for smallification: a) kernel (reqs for kernel team), b) lang & docs (reqs for packaging tools team), c) cloud-init refactoring
| |
| * Docker security ( = strong selling point): Libvirt/SELinux integration for Docker (planned but not done)
| |
| * big data spin - any needs?
| |
| * Infrastructure for automatic production and upload of cloud images for updates
| |
| * easy software stacks -- install your language of choice, preferably your version of things of choice
| |
| * integration with Fedora Server roles
| |
| * tools for user creation of images -- imagefactory?
| |
| ** repository for these images, or at least their definitions?
| |
| ** dockerfiles? same or different?
| |
| ** DOCUMENTATION -- for image creation, cloud-init, what to use when, etc.
| |
| * web site design for selecting version to launch or download -- specs to web team
| |
| == Requirement #1 (Short Description of Requirement) ==
| |
| === Feature(s) Addressed ===
| |
| Refer to which previously described Features, Use Cases this requirement helps to fulfill.
| |
| === Priority ===
| |
| Must, should, NTH
| |
| === Effort required ===
| |
| High, Medium, Low
| |
| === Stakeholders / Owners ===
| |
| === Major Dependencies ===
| |
| Any major dependencies, including things that may require any cross-working-group coordination, should be called out here. Any process changes required within Fedora should be documented here as well.
| |
| === Testing ===
| |
| Level of testing required; is it a blocker to release?
| |
| Is the testing automate-able?
| |
| === Other Documentation ===
| |
| * Existing BZ:
| |
| * Upstream webpage / wiki page / github page(s):
| |
| == Requirement #2 (Short Description of Requirement) ==
| |
| = Non-functional requirements =
| |
| These are the requirements needed that are not necessarily part of implementation of the product itself, but are still required as part of either making the product more attractive/useful, compatibility requirements for a user's workflow (ie: “works with Puppet,”) or things needing to be done/coordinated in other areas of the project (in other working groups?) to ensure a well-rounded solution.
| |
| For each, as was done with Features in a previous section, we should call out some additional information, assuming doing so makes sense for the requirement:
| |
| * Priority (Must, Should, NTH)
| |
| * Effort required
| |
| * Major dependencies / Process Changes needed
| |
| * Stakeholders/Owners
| |
| * Existing Documentation: BZ #, pointers to upstream project docs
| |
| == Image Creation ==
| |
| How to create images. Do not be shocked if there are 48 ways to do this. Also: not sure if we want to include containers in this section.
| |
| === Creation of “official” Fedora Project images ===
| |
| New images. Updated images (ie: providing newer images for a release that have updates already included) might also be included here?
| |
| === Images created by users ===
| |
| == Technical requirements ==
| |
| === Configuration Management ===
| |
| === Migration / Upgrades ===
| |
| === Performance / Scalability / Failover ===
| |
| = General requirements =
| |
| == Documentation ==
| |
| === Fedora Project Documentation ===
| |
| === Open Source Projects documentation ===
| |
| Ensuring that Fedora is well-represented, up-to-date in other open source project documentation...
| |
| == Release Criteria ==
| |
| = Technical requirements =
| |
| == Maintainability ==
| |
| == Support Requirements == | |
| === Architectures Supported ===
| |
| * x86
| |
| * x86_64 | | * x86_64 |
| * at some point: ARM (which variants ?) | | * aarch64 |
| === Supported (platforms?) ===
| | |
| Virtualization types? Container types?
| | = Participants = |
| == Internationalization / Localization == | | Currently the following people are involved in the Cloud Working group. |
| * NTH: Cloud Product base images should only includes en.us_US locale since it is meant to be used as an deployment target to save space. Other locales should be available through repositories.
| | |
| The idea is to rely on langpacks rather than RPM wizardry.
| | * [https://fedoraproject.org/wiki/User:Davdunc David Duncan] |
| == Logging / Auditing ==
| | |
| == Monitoring / Notification ==
| | * [https://fedoraproject.org/wiki/User:Dustymabe Dusty Mabe] |
| == Database requirements ==
| | |
| == Security ==
| | * [https://fedoraproject.org/wiki/User:Mhayden Major Hayden] |
| = About this Document =
| | |
| This PRD (Product Requirements Document) is an evolving document, created by the Fedora Cloud SIG Working Group as part of the process for designing the Fedora Cloud product. The framework for the PRD itself is currently in a draft state.
| | * [https://fedoraproject.org/wiki/User:Ngompa Neal Gompa] |
| This document will evolve over time as the purpose of the SIG continues to be determined as the working group process gets under way and initial products start to get produced.
| | |
| == Authors ==
| | * [https://fedoraproject.org/wiki/User:Dcavalca Davida Cavalca] |
| Contributors to this document include:
| | |
| * [[User:rbergero|Robyn Bergeron]] | | * [https://fedoraproject.org/wiki/User:Salimma Michel Salim] |
| * [[User:mattdm|Matthew Miller]] | | |
| * [[User:skottler|Sam Kottler]] | | * [https://fedoraproject.org/wiki/User:Chrismurphy Chris Murphy] |
| * [[User:Hguemar| Haïkel Guémar]] | | |
| Some aspects of Fedora Cloud personas are based on [https://docs.google.com/document/d/16rkiXWxxgzGT47_Wc6hzIPzO2-s2JWAPEKD0gP2mt7E OpenStack personas] (licensed under CC-By 3.0).
| | * [https://blog.centos.org/2022/03/new-centos-director-amy-marrich/ Amy Marrich] |
| == Reviewers & Contributors ==
| | |
| The following people have contributed to the development of this document, through feedback on IRC, mailing lists, and other points of contact.
| | * [https://fedoramagazine.org/joe-doss-how-do-you-fedora/ Joe Doss] |
| * [[User:mattdm|Matthew Miller]] | | |
| == Community Information ==
| | Many others have participated in the past and the projects a whole was |
| The Fedora Cloud SIG is one of many teams within the Fedora Project.
| | founded by the current (2022) [https://docs.fedoraproject.org/en-US/council/fpl/ FPL], [https://fedoraproject.org/wiki/User:Mattdm Matthew Miller]. Matthew has been integral in |
| The Cloud SIG mailing list is located [https://admin.fedoraproject.org/mailman/listinfo/cloud here.]
| | working on the scope and practices followed by the Cloud Working Group for many years. |
| Minutes and logs from IRC meetings related to the development of this document should be listed here as the document evolves.
| | |
| == Approval History ==
| | |
| Over time, it is expected that this document will undergo various rounds of review, approval, and editing; in the future, it may be rewritten for different releases of Fedora.
| | = Project Status = |
| While one can review the history of a wiki document (by clicking the "history" tab), it is useful to provide explicit indicators of any major format changes, approvals, or indications of it being in a “final” state, in a list that can allow someone to quickly see that all of the prescribed layers of approval have occured.
| | The Working group is '''ACTIVE''' |
| * January 8, 2014: Collaborative hackfest day.
| | |
| * October 28, 2013: [http://fedoraproject.org/w/index.php?title=Cloud_PRD&oldid=358260 Initial Draft of template.]
| | Currently the Cloud Working Group is focused on returning to status as |
| * FutureDate: Approval by SomeGroup; link to any pertinent mail announcement and/or meeting minutes
| | an [https://fedoraproject.org/wiki/Changes/RestoreCloudEdition Edition]. Edition status lapsed as a result of a number of |
| ==Tracking of Progress== | | changes. The first was a move to focus efforts related to cloud images |
| This document contains numerous descriptions of use cases, descriptions of feature sets to address the use cases, and the requirements to enable those features. Numerous Fedora self-contained and systemwide changess (in addition to updates to individual packages) may combine to address those use cases and feature sets. Thus, as a single release, or even series of releases, undergoes development, it is useful to easily track how an entire use case or feature set may be progressing.
| | to include [https://projectatomic.io/ Project Atomic] as well as the standard cloud edition and |
| While Fedora uses the [[Changes/Policy | Changes Process]] to track changes in the distribution, those changes are typically described as details of changes to a specific package, or the introduction of a specific package, rather than as a piece of a larger feature set.
| | then a complication occurred when Fedora Atomic was replaced by Fedora |
| This document could possibly be used to do any or a number of the following things:
| | CoreOS. The directives for these working groups is distinctly |
| * Provide a secondary location where changes are tracked (which seems like a lot of overhead to me)
| | different and supports different goals related to downstream adoption |
| * Provide a location where overall Feature Progress is tracked, via periodic cross-checking against Change pages; this could be either in a standalone section, or simply attached to each Feature description.
| | and support. |
| * Scope out how features are expected to progress over a number of releases.
| | |
| * None of these things.
| | == Meeting Times == |
| FIXME -- add this When we more fully determine how to most efficiently track progress, the pointer to where that tracking is done, and/or the description of or process by which we do the tracking is formalized, should be documented in this section in lieu of what is currently written here.
| | Bi-Weekly, every other Thursday. Currently we are supposed to be meeting at 15:00 UTC, but we have been meeting accidentally at 8:00 AM EDT daylight savings time. We are considering meeting on the 1st and 3rd of the month with a Video meeting on the 5th week of months that have a 5th week. Changing the meeting time would allow us to synchronize with the CentOS Cloud SIG for consistency. |
| == Document Conventions==
| | |
| === Definitions and Acronyms === | | ---- |
| * AWS: Amazon Web Services
| | === Footnotes === |
| * Amazon EC2: Amazon Elastic Compute Cloud, a popular public IaaS
| | |
| * IaaS: Infrastructure as a Service
| | [1] https://lwn.net/Articles/821158/n |
| * PaaS: Platform as a Service
| |
| * SaaS: Software as a Service
| |
| * PRD: Product Requirements Document
| |
| * [[EPEL]]: Extra Packages for Enterprise Linux
| |
| * CI: Continuous Integration
| |
| * CD: Continuous Delivery or Continuous Deployment
| |
| * [[SoftwareCollections | SCL]]: Software Collections
| |
| * [[Category:SIGs|Special Interests Groups]]: teams in charge of some aspects of Fedora Project
| |
| * NTH: Nice-to-have
| |
| * BZ: [[Bugzilla]]
| |
| * GUI: Graphical User Interface
| |
| * CLI: Command Line Interface
| |
| * API: Application Programming Interface
| |
