README.rst

   1 ..
   2  Copyright 2018 Whitestack, LLC
   3  *************************************************************
   4
   5  This file is part of OSM policy management module
   6  All Rights Reserved to Whitestack, LLC
   7
   8  Licensed under the Apache License, Version 2.0 (the "License"); you may
   9  not use this file except in compliance with the License. You may obtain
  10  a copy of the License at
  11
  12           http://www.apache.org/licenses/LICENSE-2.0
  13
  14  Unless required by applicable law or agreed to in writing, software
  15  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  16  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  17  License for the specific language governing permissions and limitations
  18  under the License.
  19  For those usages not covered by the Apache License, Version 2.0 please
  20  contact: bdiaz@whitestack.com or glavado@whitestack.com
  21
  22 OSM POL Module
  23 ****************
  24
  25 POL is a policy management module for OSM.
  26 It configures and handles autoscaling policies and vnf defined alarms.
  27
  28 Components
  29 **********
  30
  31 POL module has the following components:
  32
  33 * POL Alarming Service: Handles VNF alarms.
  34 * POL Autoscaling Service: Handles autoscaling policy configuration, alarms creation and executing scaling actions through LCM.
  35 * POL Agent: Listens message bus and calls action in corresponding service.
  36
  37 Configuration
  38 *************
  39
  40 Configuration is handled by the file [pol.yaml] (osm_pol/core/pol.yaml). You can pass a personalized configuration file
  41 through the `--config-file` flag.
  42
  43 Example:
  44
  45     osm-policy-agent --config-file your-config.yaml
  46
  47 Configuration variables can also be overridden through environment variables by following the convention:
  48 OSMPOL_<SECTION>_<VARIABLE>=<VALUE>
  49
  50 Example:
  51
  52     OSMPOL_GLOBAL_LOGLEVEL=DEBUG
  53
  54 Development
  55 ***********
  56
  57 The following is a reference for making changes to the code and testing them in a running OSM deployment.
  58
  59 ::
  60
  61     git clone https://osm.etsi.org/gerrit/osm/POL.git
  62     cd POL
  63     # Make your changes here
  64     # Build the image
  65     docker build -t opensourcemano/pol:develop -f docker/Dockerfile .
  66     # Deploy that image in a running OSM deployment
  67     docker service update --force --image opensourcemano/pol:develop osm_pol
  68     # Change a specific env variable
  69     docker service update --force --env-add VARIABLE_NAME=new_value osm_pol
  70     # View logs
  71     docker logs $(docker ps -qf name=osm_pol.1)
  72
  73
  74 Developers
  75 **********
  76
  77 * Benjamín Díaz <bdiaz@whitestack.com>, Whitestack, Argentina
  78
  79 Maintainers
  80 ***********
  81
  82 * Benjamín Díaz, Whitestack, Argentina
  83
  84 Contributions
  85 *************
  86
  87 For information on how to contribute to OSM POL module, please get in touch with
  88 the developer or the maintainer.
  89
  90 Any new code must follow the development guidelines detailed in the Dev Guidelines
  91 in the OSM Wiki and pass all tests.
  92
  93 Dev Guidelines can be found at:
  94
  95     [https://osm.etsi.org/wikipub/index.php/Workflow_with_OSM_tools]