Skip to content

Releases: oracle/oci-designer-toolkit

May 2024 Release

31 May 09:47
690d2f9
Compare
Choose a tag to compare

# May 2024 Release (Version 0.60.0)


Update 0.60.0: This update addresses the following issues.

  1. Modify OCI Import View CSS to allow the view to scroll to the bottom of the list and display the last element.

Welcome to the May 2024 release of OKIT. There is only a single update in this version for the original OKIT (Web) but core to this release is the first public Beta of the new OKIT - Open Cloud Designer or OCD.

OKIT (Web) Features

  1. Dynamic Groups: A new Dynamic groups resource has been added to the palette; allowing users to define this resource in addition to the existing Identity Groups.

OKIT - Open Cloud Designer

The public Beta version of the OKIT - Open Cloud Designer is now available for user testing and the native desktop installs are attached to this release.

This Beta release shows the new desktop functionality that will be available in the next iteration of OKIT providing Native Installers rather than the current Web Based solution. In addtion to a native installation the designer provides a true Drag-&-Drop interface allowing the user to define the layout of there design without any of the previous restrictions.

The concept of container based layouts has been remove and as such Compartment are nolonger represented on the canvas but are created as tabs across the top of the design with functionality that will allow the user to hide/show resources associated with the compartment. We have also added the concept of multiple Page/Views of the designs resources by placing page tabs at the bottom of the design. Here the user can create addition pages to show sub-sets of the designs resources, which can be selected from the "model" palette.

At present the Open Cloud Designer only supports a subset of the original OKIT (Web) resources but this covers the core resource and more will be added soon.

Available Resources

Resource Properties Terraform Validation Query Query Only
VCN
Subnet
Security List
Route Table
DHCP Options
Internet Gateway
NAT Gateway
Instance
Autonomous Database
Load Balancer
Load Balancer Backend Set
Load Balancer Backend
Load Balancer Backend Listener
Block Volume
Volume Attachment
Boot Volumes
Boot Volumes Attachment
Customer Premises Equipment
Database System
Service Gateway
DRG
Local Peering
IPSec VPN
Dynamic Groups
Groups
Users

Native Installs

At present we do not have any certificates associated with these and hence you may see some security warnings during execution. If you are happy to accept that the installation files built by GitHub are okey then
you will need to acknowledge in the appropriate dialog for your system.

OCD Desktop Features

The OCD Desktop / Web interface is composed of a number of section similar to those provided in the original OKIT BUI. These provide similar functionality but with some key difference that will be document below.

OCD Desktop

Palette

Location of all resources that can be used within OCD. These are split into two tabs.

Provider

The Provider tab contains a set of provider (currently only OCI) Resources that are available within the OCD Desktop to design your architecture. These resources can be displayed in either a simple, icon only, or a verbose format, icon and name. When you want to add a resource to your architecture simply drag it from the palette onto the canvas.

Model

The Model tab contains a list of all Resource that have already been added to the design allowing the user to drag a second copy of the resource onto the canvas, either the
same Page/View or a new Page/View.

Canvas

Freeform location where your design can be created. Once a Resource has been dragged from the palete and dropped on the canvas it can subsequently be moved as required by the user. In addition container style Resource (Vcn / Subnet) will also allow resize and can contain other resources. It should be noted that Compartments are not represented on the
canvas as a Resource but rather created as Layers using the top tab bar. These compartment layers can subsequently be shown/hidden and the Resources within the Compartment layer will be shown/hidden on the canvas. In addition Compartment Layers can be coloured (Style in properties) and if the "Highlight Compartment Resources" is selected from the designer menu (above the palette)
then the borders of resource will be coloured to match the compartment.

Pages/Views

The Page/View Tabs (at base of canvas) allow the user to create multiple visual representations of the same design/model by selecting resources from the "Model" palette.

Properties

The properties panel provides access to the edittable properties available for the selected Resource. In addition the User can provide Resource specific documentation that will be included in any generated Markdown.

OCD nightly Release 0.2.0

30 May 15:01
Compare
Choose a tag to compare
- Beta Code: This is experimental and work in progress. Therefore does not provide all the functionality in OKIT.

Getting Started OKIT Open Cloud Designer

The OCD project is a refactoring of the original OKIT implementation and TypeScript / JavaScript
based implementation using React to build the interface and provide the WebServer. In addition
Electron is used to generate native installers for simplicity of installation and use.

This Beta release is to show the new desktop functionality available in the OKIT - Open Cloud Desktop release and is not
guarenteed to be 100% functional. At present the following resources and features are availble but we will be releasing updates
regularly.

Resource Properties Terraform Validation Query Query Only
VCN
Subnet
Security List
Route Table
DHCP Options
Internet Gateway
NAT Gateway
Instance
Autonomous Database
Load Balancer
Load Balancer Backend Set
Load Balancer Backend
Load Balancer Backend Listener
Block Volume
Volume Attachment
Boot Volumes
Boot Volumes Attachment
Customer Premises Equipment
Database System
Service Gateway
DRG
DRG Attachment
DRG Route Table
DRG Distribution
Local Peering
IPSec VPN
Remote Peering
NoSQL Database
MySQL (with Heatwave)
Vault
Key
Secret
File System
Mount Target
OKE Cluser & Node Pool
Analytics Instance
Policy
Dynamic Groups
Groups
Users

Not all menu options are currently available and if selected will display a message saying they are currently not availble,
again these will be added over time.

If you have any comments please leave them on the GitHub issues marked as OCD Beta:

Native Installs

The OCD Beta Nightly Release contains a number of native install artefacts which can be used to install OCD on you machine.
At present we do not have any certificates associated with these and hence you may see some security warnings during execution. If you are happy to accept that the installation files built by GitHub are okey then
you will need to acknowledge in the appropriate dialog for your system.

MacOS

Error

Security Acknowledgement

Solution

System Settings -> Security

Security Acknowledgement

Select "Open Anyway"

OCD Desktop Features

The OCD Desktop / Web interface is composed of a number of section similar to those provided in the original OKIT BUI. These
provide similar functionality but with some key difference that will be document below.

OCD Desktop

Palette

Location of all resources that can be used within OCD. These are split into two tabs.

Provider

The Provider tab contains a set of provider (currently only OCI) Resources that are available within the OCD Desktop to design your architecture. These resources can be displayed in either a simple, icon only, or a verbose format, icon and name. When you want to add a resource to your architecture simply drag it from the palette onto the canvas.

Model

The Model tab contains a list of all Resource that have already been added to the design allowing the user to drag a second copy of the resource onto the canvas, either the
same Page/View or a new Page/View.

Canvas

Freeform location where your design can be created. Once a Resource has been dragged from the palete and dropped on the canvas it can subsequently be moved as required by the user. In addition container style Resource (Vcn / Subnet) will also allow resize and can contain other resources. It should be noted that Compartments are not represented on the
canvas as a Resource but rather created as Layers using the top tab bar. These compartment layers can subsequently be shown/hidden and the Resources within the Compartment layer will be shown/hidden on the canvas. In addition Compartment Layers can be coloured (Style in properties) and if the "Highlight Compartment Resources" is selected from the designer menu (above the palette)
then the borders of resource will be coloured to match the compartment.

Pages/Views

The Page/View Tabs (at base of canvas) allow the user to create multiple visual representations of the same design/model by selecting resources from the "Model" palette.

Properties

The properties panel provides access to the edittable properties available for the selected Resource. In addition the User can provide Resource specific documentation that will be included in any generated Markdown.

Build Your Own

Prerequisites

  • node / npm

Installing

Before the application can be either built as a desktop or run as a web server all appropriate node modules must be
installed. This can be achieve by executing the fresh-install of reinstall script, from this directory, as follows:

npm run fresh-install

This will create the oci-designer-toolkit/oci/dist directory which will contain a subdirectory for the appropriate opperating system, for example :

ls -1
builder-debug.yml
builder-effective-config.yaml
mac

ls -1 mac
mac
ocd-0.1.0.dmg
ocd-0.1.0.dmg.blockmap
ocd-0.1.0.zip
ocd-0.1.0.zip.blockmap

In the above example the ocd-0.1.0.dmg can be opened in the normal way on a mac and the app will be installed.

Running Desktop Application without installing

  1. Build Desktop Application
npm run desktop

Running Development Web Application

  1. Run Web Server
npm run web
  1. Access BUI on http://localhost:3000/

C3 Branding

30 Apr 10:54
d3ab8fa
Compare
Choose a tag to compare

Features

  1. Add Compute Cloud@Customer as deployment platform with associated resources.

Bug Fixes

  1. Resolve issue with oci.application_migration being missing from the latest oci sdk
  2. Remove Ansible references from documentation.

PCA Functionality Update

06 Dec 14:59
74a5b3b
Compare
Choose a tag to compare

Features

  1. Force Mount Target exports to have AUTOSELECT path for none OCI targets.
  2. Force Instance volumes attachment type to Paravirtualized for none OCI targets.
  3. Modify Block Storage Volume for PCA to allow specification of High Performance.

Bug Fixes

  1. Change Validation so that missing hostname does not report failure for this warning.
  2. Change PCA Volume Attachment query to convert AD Correctly.
  3. For Numeric fields in the Generator remove all none decimal characters.
  4. Fix instance delete failing when loadbalancers are used.

Pricing Update

16 Nov 10:58
62f6da5
Compare
Choose a tag to compare

Features

  1. Update pricing module for new GPU
  2. Extend functionality of OCD Alpha Release

Bug Fixes

C3 Prep Release

04 Oct 12:25
926a17c
Compare
Choose a tag to compare

Features

  1. Extend PCA Query to lookup Images in all Tenancy Compartments.
  2. Remove unsupported DNS Zone icon.
  3. Prep for C3 Release.

Bug Fixes

  1. Resolve issue where availability domain was not passed as integer to the subnet.jinja2

Documentation Patch

22 Sep 10:43
ec18449
Compare
Choose a tag to compare

Bug Fixes

  1. Update Linux Native install instructions to specify OCI Config information must exist below roots home directory.

Fix issue where banner dropdown failing to load on hard refresh

31 Aug 15:08
9393bd8
Compare
Choose a tag to compare

Patch fix for

Bug Fixes

  1. Fix issue where banner dropdown failing to load on hard refresh.

Async load for OCI Drop down data

31 Aug 12:07
1a99850
Compare
Choose a tag to compare

Features

Bug Fixes

  1. Modify load calls for OkitOciData to use Promise and async.

Patch: Allow Resource Manager to use Session Config

29 Aug 12:45
c8e2eb8
Compare
Choose a tag to compare

Bug Fixes

  1. Fix issue where Export To Resource Manager was not using Session based configuration.