You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

The Ribbon Automation Framework (RAF) is a framework of tools/modules and Operators to deploy and manage Ribbon Products in a declarative way, and provides CLI and REST interfaces. Using RAF, various Ribbon Products can be deployed and managed on Public and Private cloud platforms. Contact Ribbon's Account Teams for further details

Flow Diagram

The following flow diagram represents the overall procedure order and systems used.

AWS Automation Script

KVM Automation Script

RAF Operator AWS


Prerequisites

Software Bundle

The following table contains the list of required files.

File Names

sbc-V10.00.00R000-aws_container.tar.gz

Procedure

This section outlines how to set up your 

Unable to show "metadata-from": No such page "_space_variables"
(
Unable to show "metadata-from": No such page "_space_variables"
) container environment.

Caution

Persistent data (such as object states) is maintained in the /objects directory of the container, which is mapped to a host directory or volume. You must make sure that the disk space is reliable and persistent (for example, by using network or cloud storage). If you use a Docker desktop for Windows, you must use a volume because you cannot set permissions on files created in an NTFS formatted host directory. For information about what happens when you specify a non-existent volume while using the docker run command to start the container, refer to the Tips for using bind mounts or volumes section in Manage data in Docker.

For more information about

Unable to show "metadata-from": No such page "_space_variables"
, refer to the following:

Note

The procedure in this section uses the Docker container as an example, but you can set up RAF in any container environment.


Note

The manifest files are available at /example/payloads/sbc/aws/.

Prerequisites

Before you set up the 

Unable to show "metadata-from": No such page "_space_variables"
Docker container, you must have the following:

  • A system with a minimum of 4 GB RAM and 2 vCPUs
  • A host machine with Docker installed. To install Docker, refer to the Docker Installation procedure for your operating system.
  • A Docker engine that is running.
  • Appropriate access rights on the host machine to run Docker commands (refer to Manage Docker as a non-root user for Linux-based hosts).
  • A compressed 
    Unable to show "metadata-from": No such page "_space_variables"
    container image.
Start
  1. Log into your Linux host server.

  2. Use the following command to load the 

    Unable to show "metadata-from": No such page "_space_variables"
    container image.

    Note

    To check your 

    Unable to show "metadata-from": No such page "_space_variables"
    container image, use the following command: docker images.

    docker load --input sbc-V10.00.00R000-aws_container.tar.gz

  3. Create the following host persistent storage (similar to cloud storage) where you can save 

    Unable to show "metadata-from": No such page "_space_variables"
    product images, automation scripts, cloud and virtual resource state information, and such.

    Note

    You can copy only a single automation scripts tarball into your directory.

    • objects: Stores resource state information and logs. Depending on the deployment size, 2 to 4 GB is required.
    • resources: The images and automation scripts specific to the product and provider. The size requirement is based on the sum of all the files you will store in this host persistent storage.

    To create the host persistent storage, you must copy the product QCOW2 image tarball to the $WORKDIR/resources/images directory and the automation scripts tarball (for example, sbc-V09.01.00R000-aws_automation_scripts.tar.gz) to the $WORKDIR/resources/scripts directory. The following is an example of how to create the host persistent storage.

    Example
    WORKDIR=/opt/ribbon
mkdir -p $WORKDIR/objects $WORKDIR/resources/images $WORKDIR/resources/scripts

  4. Use the following command syntax to run the 

    Unable to show "metadata-from": No such page "_space_variables"
    container.

    Note

    Each container must have a unique <container_name> and <host_port>.

    docker run -d --name=<container_name> -p <host_port>:80 --mount "type=bind,src=<host_persistent_storage>,dst=/objects" --mount "type=bind,src=<host_static_resource>,dst=/resources,readonly" <imageName:tag>

    In the preceding command,

    • <container_name> is the name of the container you want to launch.

    • <host_port> is the UDP or TCP port number of the host that you want to map to the 

      Unable to show "metadata-from": No such page "_space_variables"
      container port.

    • <host_persistent_storage> is a host directory.

    • <host_static_resource> is a host directory that contains static resources such as disk images and the automation scripts tarball.

    • <imageName:tag> is the name of the 

      Unable to show "metadata-from": No such page "_space_variables"
      container image.

      The following is an example of how to run the 
      Unable to show "metadata-from": No such page "_space_variables"
      container.

      Example
      docker run -d --name=raf_test -p 8080:80 --mount "type=bind,src=$WORKDIR/objects,dst=/objects" --mount "type=bind,src=$WORKDIR/resources,dst=/resources,readonly" raf:20.08`

  5. Use one of the following procedures to access the

    Unable to show "metadata-from": No such page "_space_variables"
    . Use the CLI to deploy and manage products manually, and the REST API to deploy and manage products using automation.

    Note

    You can also use both procedures. For example, you can use the CLI to deploy your product and the REST API to manage the product (and the other way).

  6. Use the following command to stop 

    Unable to show "metadata-from": No such page "_space_variables"
    container: docker stop <container_name>

  7. Use the following command to delete 

    Unable to show "metadata-from": No such page "_space_variables"
    container: docker rm <container_name>

  8. Use the following commands to restart the 

    Unable to show "metadata-from": No such page "_space_variables"
    container:

    docker start <container_name>
docker restart <container_name>

For the procedures to use the CLI to deploy products and to use the RAF REST API to deploy and manage products, refer to the Readme file located at examples/payloads/sbc/aws/README.md.

  • No labels