Oracle Cloud Infrastructure Designer and Visualisation Toolkit 0.66.1

Full Release Details Can Found 0.66.1 Release.

OKIT - Open Cloud Designer Public Beta is now Available see 0.66.1 Release for details.

---

OCI designer and visualisation 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

• Export

  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 or Markdown for documentation.

  • Terraform
  • OCI Resource Manager
  • Markdown

  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.

Changes

Changes for the current release (0.66.1) are documented here.

Releases

See Releases

Blogs

• Introduction to OKIT the OCI Designer Toolkit
• The OCI Designer Toolkit Templates Feature
• The OCI Designer Toolkit Query Feature
• OCI Designer Toolkit Resource Manager Integration
• The OCI Designer Toolkit Documentation Generation

Installation

OKIT-Web

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

1. MacOS
2. Windows 10 / WSL (Ubuntu)
3. Oracle Linux

OKIT-Ocd

OKIT-Ocd is the next iteration of OKIT and is currently available as a Beta release. The native installables can be found in the Assets section on the 0.66.1 Release.

1. MacOS
   1. Arm dmg
   2. x64 dmg
2. Windows
   1. Setup
3. Linux
   1. rpm
   2. deb

OCI Config File

Create the OCI cli config file in the directory <USER HOME DIR>/.oci with contents similar to that below. The key_file is a fixed value because the contents of the <USER HOME DIR>/.oci will be mounted to the appropriate users home directory, as ~/.oci, during the run 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

If connecting to a PCA or C3 machine that requires a cert bundle then an additional entry will need to be added to the config file entry specifying the location of the cert bundle similar to the following.

cert-bundle=~/.oci/certs/certbundle.cert

GIT Settings File

If Git integration is required you will need to create a git_repositories file within the directory <USER HOME DIR>/.oci with contents similar to that below.

[OKIT Community Templates]
branch=main
url[email protected]:username/okit-community-templates.git
  
[Example Repo]
branch = master
url = [email protected]

[Internal]
branch = BRANCHNAME
url = [email protected]

This properties file contains a list of the Git repositories you want to access. It assumes that you are using public/private key access, the key files exist within your <USER HOME DIR>/.ssh directory and the <USER HOME DIR>/.ssh/config defines the key/url mapping, similar to the following.

Host github.com
	IdentityFile ~/.ssh/id_rsa_github

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

This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide

Security

Please consult the security guide for our responsible security vulnerability disclosure process

License

Copyright (c) 2020, 2024, Oracle and/or its affiliates.

Released under the Universal Permissive License v1.0 as shown at https://oss.oracle.com/licenses/upl/.

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