Skip to content

Latest commit

 

History

History
100 lines (75 loc) · 7.65 KB

RELEASE_NOTES.md

File metadata and controls

100 lines (75 loc) · 7.65 KB

License: UPL Quality Gate Status

November 2024 Release (Version 0.66.1)


Update 0.66.1: This update addresses the following issues.

  1. Update main README to de-emphasise Docker

Welcome to the November 2024 release of OKIT. This release switches the exiat Create React App based build format to Vite and Electron Forge.

OKIT (Web) Features

OKIT - Open Cloud Designer

  1. OKIT-Ocd: Convert @ocd/core to ES6 Module (#OKIT-307)
  2. OKIT-Ocd: Convert @ocd/model to ES6 Module (#OKIT-308)
  3. OKIT-Ocd: Convert @ocd/query to ES6 Module (#OKIT-309)
  4. OKIT-Ocd: Convert @ocd/export to ES6 Module (#OKIT-310)
  5. OKIT-Ocd: Convert @ocd/import to ES6 Module (#OKIT-311)
  6. OKIT-Ocd: Convert @ocd/codegen to ES6 Module (#OKIT-312)
  7. OKIT-Ocd: Convert @ocd/codegen-cli to ES6 Module (#OKIT-313)
  8. OKIT-Ocd: Convert @ocd/cli to ES6 Module (#OKIT-314)
  9. OKIT-Ocd: Convert @ocd/desktop to ES6 Module (#OKIT-315)
  10. OKIT-Ocd: Switch build process from Create React App / Webpack to Vite (#OKIT-305)
  11. OKIT-Ocd: Switch to Electron Forge for building.

Beta Overview

The public Beta 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.