diff --git a/README.md b/README.md index 86803ad..a6cd0a1 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,15 @@ -Picasso: Functions-as-a-Service (FaaS) on OpenStack -=================================================== +# Picasso: Functions-as-a-Service (FaaS) on OpenStack -Mission -------- +## Mission -Picasso provides an API abstraction layer for Functions-as-a-Service (FaaS) on OpenStack. +Picasso aims to provide an API abstraction layer for Functions-as-a-Service (FaaS) on OpenStack. -Serverless ----------- +## What is Serverless/FaaS? -Serverless is a new paradigm in computing that enables simplicity, -efficiency and scalability for both developers and operators. -It's important to distinguish the two, because the benefits differ: +Serverless is a new paradigm in computing that enables simplicity, efficiency and scalability for both developers +and operators. It's important to distinguish the two, because the benefits differ: -Benefits for developers ------------------------ +### Benefits for developers The main benefits that most people refer to are on the developer side and they include: @@ -23,8 +18,10 @@ The main benefits that most people refer to are on the developer side and they i * Pay by the milliseconds your code is executing -- unlike a typical application that runs 24/7, and you're paying 24/7, functions only run when needed -Benefits for operators ----------------------- +Since you'll be running IronFunctions yourself, the paying part may not apply, but it does apply to +cost savings on your infrastructure bills as you'll read below. + +### Benefits for operators If you will be operating IronFunctions (the person who has to manage the servers behind the serverless), then the benefits are different, but related. @@ -39,61 +36,54 @@ then the benefits are different, but related. * Scaling is the same for all functions, you don't scale each app independently * Scaling is simply adding more IronFunctions nodes -System requirements -------------------- + +### System requirements * Operating system: Linux/MacOS * Python version: 3.5 or greater * Database: MySQL 5.7 or greater -Quick-start guide ------------------ +### Quick-start guide -Install DevStack with [IronFunctions enabled](https://github.com/iron-io/functions-devstack-plugin/blob/master/README.rst). -Pull down [Picasso sources](https://github.com/iron-io/project-picasso). +* Install DevStack with [IronFunctions enabled](https://github.com/iron-io/picasso/blob/master/devstack/README.rst) +* Clone the [Picasso source](https://github.com/iron-io/picasso) -Create Python3.5 virtualenv: +Create a Python3.5 virtualenv $ virtualenv -p python3.5 .venv $ source .venv/bin/activate -Install dependencies: +Install dependencies $ pip install -r requirements.txt -r test-requirements.txt -Install Picasso itself: +Install Picasso $ pip install -e . -Install MySQL if you haven't already, and create a new database for functions. +Install MySQL if you haven't already, and create a new database for functions $ mysql -uroot -p -e "CREATE DATABASE functions" +### Migrations -Migrations ----------- - -Once all dependencies are installed it is necessary to run database migrations. -Before that it is necessary to set env variable: +Once all dependencies are installed it is necessary to run database migrations. First, +set the following environment variable: export PICASSO_MIGRATIONS_DB=mysql+pymysql://root:root@localhost/functions -In this section please specify connection URI to your own MySQL database. -Once the file is saved, just use alembic to apply the migrations: +Use `alembic` to apply the migrations: $ alembic upgrade head -Starting a server ------------------ - -Once it is finished you will have a console script `picasso-api`: +### Starting the Picasso API server $ picasso-api --help Usage: picasso-api [OPTIONS] - + Starts Picasso API service - + Options: --host TEXT API service bind host. --port INTEGER API service bind port. @@ -104,45 +94,43 @@ Once it is finished you will have a console script `picasso-api`: --log-file TEXT Log file path --help Show this message and exit. -Minimum required options to start Picasso API service: +The following are the minimum required options to start the Picasso API service: --db-uri mysql://root:root@192.168.0.112/functions --keystone-endpoint http://192.168.0.112:5000/v3 --functions-url http://192.168.0.112:8080/v1 --log-level INFO -Creating and running Picasso inside Docker container -------------------------------------------------- +### Building and Running Picasso in Docker -As part of regular Python distribution, Picasso also has its own Docker container to run. -There are two options: - -* run from sources -* run from Docker Hub - -In order to build container from sources run following commands: +From the Picasso repo, build a Docker image: export DOCKER_HOST=tcp://: docker build -t picasso-api -f Dockerfile . -After that it is required to create correct version of [Dockerfile.env](Dockerfile.env.example). -It container all required options to start Picasso API service properly. -Once it is done run following commands: +To start the container, pass in the required env vars, by - docker run -d -p 10001:10001 --env-file Dockerfile.env picasso-api +`--env-file` example [Dockerfile.env](Dockerfile.env.example) -Navigate to your web browser to check if service is running: + docker run -d -p 10001:10001 --env-file Dockerfile.env picasso-api + +or by entering all values in `-e =` format. + +Once the container is started, check if the service in running: + +In your web browser navigate to: :10001/api -or using CLI +or using the CLI: curl -X GET http://:10001/api/swagger.json | python -mjson.tool -Examining API -------------- +### Examining the API -In [examples](examples/) folder you can find a script that examines available API endpoints, but this script relays on: +In [examples](examples/) folder you can find a script that examines available API endpoints. + +Note that this script depends on the following env vars: * `PICASSO_API_URL` - Picasso API endpoint * `OS_AUTH_URL` - OpenStack Auth URL @@ -152,27 +140,20 @@ In [examples](examples/) folder you can find a script that examines available AP * `OS_DOMAIN` - OpenStack project domain name * `OS_PROJECT_NAME` - OpenStack project name -Then just run script: +To run the script: OS_AUTH_URL=http://192.168.0.112:5000/v3 OS_PROJECT_ID=8fb76785313a4500ac5367eb44a31677 OS_USERNAME=admin OS_PASSWORD=root OS_DOMAIN=default OS_PROJECT_NAME=admin ./examples/hello-lambda.sh -Please note, that given values are project-specific, so they can't be reused. +Please note that values provided are project-specific, so they can't be reused. -API docs --------- +### API docs -As part of Picasso ReST API it is possible to discover API doc using Swagger Doc. -Once server is launched you can navigate to: +API docs are discoverable via Swagger. Just launch the Picasso API and browse to: http://:/api -to see recent API docs +### Support +You can get community support via: -Contacts --------- - -Feel free to reach us out at: - -* [Slack channel](https://open-iron.herokuapp.com/) -* [Email](https://github.com/denismakogon) + * [Slack](https://open-iron.herokuapp.com/) \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..f92e731 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,216 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source + +.PHONY: help +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " applehelp to make an Apple Help Book" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +.PHONY: clean +clean: + rm -rf $(BUILDDIR)/* + +.PHONY: html +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +.PHONY: dirhtml +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +.PHONY: singlehtml +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +.PHONY: pickle +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +.PHONY: json +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +.PHONY: htmlhelp +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +.PHONY: qthelp +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Picasso.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Picasso.qhc" + +.PHONY: applehelp +applehelp: + $(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp + @echo + @echo "Build finished. The help book is in $(BUILDDIR)/applehelp." + @echo "N.B. You won't be able to view it unless you put it in" \ + "~/Library/Documentation/Help or install it in your application" \ + "bundle." + +.PHONY: devhelp +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/Picasso" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Picasso" + @echo "# devhelp" + +.PHONY: epub +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +.PHONY: latex +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +.PHONY: latexpdf +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: latexpdfja +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +.PHONY: text +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +.PHONY: man +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +.PHONY: texinfo +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +.PHONY: info +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +.PHONY: gettext +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +.PHONY: changes +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +.PHONY: linkcheck +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +.PHONY: doctest +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +.PHONY: coverage +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +.PHONY: xml +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +.PHONY: pseudoxml +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..7dd1abc --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,285 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Picasso documentation build configuration file, created by +# sphinx-quickstart on Thu Nov 24 13:24:43 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.coverage', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Picasso' +copyright = '2016, Iron.io' +author = 'Iron.io' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '0.0.1' +# The full version, including alpha/beta/rc tags. +release = '0.0.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (relative to this directory) to use as a favicon of +# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Picassodoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Picasso.tex', 'Picasso Documentation', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'picasso', 'Picasso Documentation', + [author], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Picasso', 'Picasso Documentation', + author, 'Picasso', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/source/deployment_guide.rst b/docs/source/deployment_guide.rst new file mode 100644 index 0000000..93ccbf8 --- /dev/null +++ b/docs/source/deployment_guide.rst @@ -0,0 +1,84 @@ +***************************** +Picasso deployment guide +***************************** + + +DevStack +######## + +See full install guide in devstack_plugin_ + +Existing OpenStack +################## + +Required software:: + +* Python 3.5 or greater +* Go 1.7 or greater +* Glide +* OpenStack Identity (Keystone) +* Docker (single instance or clustered) + +Software that will be installed:: + +* IronFunctions +* Picasso + + +IronFunctions installation +************************** + +IronFunctions is a core component of Picasso that interacts with the Docker API. + +Run the following commands to install IronFunctions:: + + export GOPATH=~/go + export FUNCTIONS_DIR=$GOPATH/src/github.com/iron-io/functions + mkdir -p $FUNCTIONS_DIR + pushd $FUNCTIONS_DIR && GOPATH=${GOPATH} make all; popd + +Running ``$FUNCTIONS_DIR/functions`` will start IronFunctions using an embedded Bolt database running on port 8080. + +See IronFunctions configuration options_ + +Installing Picasso +****************** + +Picasso is a lightweight ReST API service to work with IronFunctions using the OpenStack Identity (Keystone) model. + + +Run the following commands to install Picasso:: + + + git clone git@github.com:iron-io/picasso.git + pip3 install -r requirements.txt + pip3 install -e . + +Review the Picasso README_ for how to get started. + +OpenStack Identity (Keystone) configuration +******************************************* + +Create a new ``functions`` service in Keystone using the OpenStack_CLI_ +This will enable the Picasso API by resolving its endpoint through the service catalog. + +Running IronFunctions in production +*********************************** + +From a deployment perspective IronFunctions is nothing more than an internal service, so its API should not be exposed to OpenStack users. + +Running Picasso in production +***************************** + +Required software:: + + Load balancer such as HaProxy or Nginx + + +The Picasso API endpoint should be available to OpenStack users, therefore it is suggested to run the API behind a load balancer. + +.. _devstack_plugin: https://github.com/iron-io/picasso/blob/master/devstack/README.rst +.. _Glide: https://github.com/Masterminds/glide +.. _options: https://github.com/iron-io/functions/blob/master/docs/options.md +.. _README: https://github.com/iron-io/picasso/blob/master/README.md +.. _OpenStack_CLI: http://docs.openstack.org/cli-reference/ \ No newline at end of file diff --git a/docs/source/functions.rst b/docs/source/functions.rst new file mode 100644 index 0000000..401cf76 --- /dev/null +++ b/docs/source/functions.rst @@ -0,0 +1,62 @@ +********* +Functions +********* + + +Writing functions +***************** + +What is a function? +################### + +Functions are small, bite sized bits of code that do one simple thing. Forget about +monoliths when using functions, just focus on the task that you want the function to perform. + +Unlike an app/API/microservice that consumes resources 24/7 whether they are in use or not, +functions are time sliced across your infrastructure and only consume resources while they are +actually doing something. + +Function composition +##################### +At a high-level, functions are comprised of applications and routes:: + + An application is essentially a grouping of functions, that put together, form an API. + + A route is a way to define a path in your application that maps to a function. + +Calling your function is as simple as requesting a URL. Each app has it's own namespace and +each route mapped to the app. + +How are functions packaged? +########################### + +Packaging a function has two parts: + +Create a Docker image for your function with an ``ENTRYPOINT``:: + + Push your Docker image to a registry (Docker Hub by default). + + Once it's pushed to a registry, you can use it by referencing it when adding a route. + +Writing functions +################# + +See the IronFunctions guide_ on writing functions. + +What functions can do +###################### + +As functions are essentially just containers, anything that runs in a container can be a function. +Functions typically useful for short-lived tasks, such as: + + * Data processing + * ETL + + +What functions cannot do +######################## + +Long running processes are not intended for functions. + + +.. _guide: https://github.com/iron-io/functions/blob/master/docs/writing.md \ No newline at end of file diff --git a/docs/source/images/intercomponent_architecture.png b/docs/source/images/intercomponent_architecture.png new file mode 100644 index 0000000..c62767a Binary files /dev/null and b/docs/source/images/intercomponent_architecture.png differ diff --git a/docs/source/images/picasso_deployment.png b/docs/source/images/picasso_deployment.png new file mode 100644 index 0000000..f69b963 Binary files /dev/null and b/docs/source/images/picasso_deployment.png differ diff --git a/docs/source/images/telemetry_use_case.png b/docs/source/images/telemetry_use_case.png new file mode 100644 index 0000000..c1dfc2e Binary files /dev/null and b/docs/source/images/telemetry_use_case.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..fbff748 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,23 @@ +.. Picasso documentation master file, created by + sphinx-quickstart on Thu Nov 24 13:24:43 2016. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Picasso documentation! +======================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + + deployment_guide.rst + functions.rst + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/tox.ini b/tox.ini index 80c46e1..5c1f228 100644 --- a/tox.ini +++ b/tox.ini @@ -1,4 +1,4 @@ -# Project LaOS +# Picasso [tox] envlist = py35-functional,py35-functional-regression,py35-integration,py35-integration-regression,pep8,docker-build,bandit @@ -57,4 +57,4 @@ commands = bandit -r picasso/ [flake8] ignore = H202,H304,H404,H405,H501 show-source = True -exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,migrations +exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,build,migrations,docs