Skip to content

Latest commit

 

History

History
97 lines (61 loc) · 3.63 KB

README.md

File metadata and controls

97 lines (61 loc) · 3.63 KB

OCI Designer Toolkit 0.11.0

OCI designer toolKIT (OKIT) is a browser based tool that allows the user to design, deploy and visualise (introspect/query) OCI environments through a graphical web based interface.

  • Design

    The Web based interface will allow architects and designers to build a visual representation of their infrastructure and then export this in a number of formats.

    • svg
    • png
    • jpeg

  • Generate

    Once completed the design can be enhanced to add key property information allowing the designed infrastructure to be exported to a number of DevOps frameworks.

    • Ansible
    • Terraform
    • OCI Resource Manager

    This allows for rapid proto-typing and building.

  • Introspect

    OKIT will also allow the user to introspect existing OCI environments, through simple query functionality embedded within the web interface, to provide a portable generic json file, that can be used to visualise existing systems or generate terraform/ansible.

Installation

Detailed OKIT Installation steps can be found in the OCI Designer Toolkit Installation Guide.

Quick Start

The docker image is the recommended runtime server OKIT provides a simple Docker Compose script to build and start the container.

Clone Repository

git clone --depth 1 https://github.com/oracle/oci-designer-toolkit.git

Create Config File

Create the OCI cli config file in the directory oci-designer-toolkit/containers/oci with contents similar to that below. The key_file is a fixed value because the contents of the oci-designer-toolkit/containers/oci will be copied to the appropriate users home directory, as ~/.oci, during the build process.

[DEFAULT]
user=ocid1.user.oc1..aaaaaaaak6z......
fingerprint=3b:7e:37:ec:a0:86:1....
key_file=~/.oci/oci_api_key.pem  
tenancy=ocid1.tenancy.oc1..aaaaaaaawpqblfem........
region=us-phoenix-1

Copy Key File

Copy your oci_api_key.pem to the oci-designer-toolkit/containers/oci directory.

Build and Start

cd oci-designer-toolkit/containers/docker
docker-compose up --detach

Note: For full connection to OCI you will need to follow the Installation Create Config File instruction prior to building.

Once started the Designer BUI can be accessed on http://localhost/okit/designer

Usage / Examples

The OKIT User / Usage Guide and worked examples can be found in the OCI Designer Toolkit Usage Guide

Changes

See CHANGELOG.

Known Issues

You can find information on any known issues with OKIT here and under the Issues tab of this project's GitHub repository. Any issues found with the tool should be raised on the projects issues page. Please check that the issue has not previously been reported.

Contributing

OCI Designer Toolkit is an open source project. See CONTRIBUTING for details.

If you would like to extend OKIT the development documentation can be found in OCI Designer Toolkit Development Guide