Releases: oracle/oci-designer-toolkit
OKIT-Classic June 2025 Release (Final End of Life Release)
June 2025 Release (Version 0.70.0) - Final End of Life Release
Update 0.70.0: This update addresses the following issues.
Welcome to the June 2025 release of OKIT. This release restructures the git repository to clearly identify Classic code.
OKIT Classic Features
- Unpdate to indicate this is the final release.
OKIT Open Cloud Designer Desktop Release
June 2025 Release (Version 0.3.0)
Update 0.3.0: This update addresses the following issues.
- Fix security list options issue where the fields were not being correctly hidden.
- Fix issue where Documentation tab was not always highlighted correctly.
Welcome to the June 2025 release of OKIT. This release extends the number of resources supported within OKIT-Desktop.
OKIT Desktop Features
- Rebrand to Edge Cloud Design Tool
- Add feature to allow the user to specify that the Identity Resource should be split from non-identity resources and create multiple directories.
- Option to Edit Lock resource, i.e. do not allow editting of fields if the lock is closed.
- Save now always guarentees a ".okit" extension
- Add Simple Theme framework.
- Create Reducer based Contexts in readiness to improve code.
- Cache
- Console Config
- Theme
- Active File
- Restructure build workflow to create Classic & Desktop releases.
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 addition 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 removed and as such Compartment are no longer 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 | ✓ | ✓ | |||
| Bastion | ✓ | ✓ | |||
| Vault | ✓ | ✓ | |||
| Key | ✓ | ✓ | |||
| Secret | ✓ | ✓ | |||
| Data Science Project | ✓ | ✓ | |||
| Data Science Notebook Session | ✓ | ✓ | |||
| Integration Instance | ✓ | ✓ |
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 okay 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.
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 palette 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 editable 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.9
- 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
Solution
System Settings -> Security
Select "Open Anyway"
For anyone trying to install the Desktop version on a Mac running Sequoia 15.x.x you will probably notice that you can no longer override the licence warning within settings. There is a way around this and it is to execute the following once thw dmg has been installed.
xattr -d com.apple.quarantine /Applications/ocd.appOCD 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.
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-installThis 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.blockmapIn 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
- Build Desktop Application
npm run desktopRunning Development Web Application
- Run Web Server
npm run web- Access BUI on http://localhost:3000/
OKIT Open Cloud Designer Desktop Release
April 2025 Release (Version 0.2.9)
Update 0.2.9: This update addresses the following issues.
Welcome to the April 2025 release of OKIT. This release extends the number of resources supported within OKIT-Desktop.
OKIT Desktop Features
- OKIT-Desktop: Add new OCI Resources
- Bastion (OKIT-322)
- Vault (OKIT-323)
- Key (OKIT-324)
- Secret (OKIT-325)
- Data Science Project (OKIT-331)
- Data Science Notebook Session (OKIT-332)
- Integration Instance (OKIT-333)
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 addition 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 removed and as such Compartment are no longer 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 | ✓ | ✓ | |||
| Bastion | ✓ | ✓ | |||
| Vault | ✓ | ✓ | |||
| Key | ✓ | ✓ | |||
| Secret | ✓ | ✓ | |||
| Data Science Project | ✓ | ✓ | |||
| Data Science Notebook Session | ✓ | ✓ | |||
| Integration Instance | ✓ | ✓ |
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 okay 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.
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 palette 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 editable properties available for the selected Resource. In addition the User can provide Resource specific documentation that will be included in any generated Markdown.
OKIT-Classic April 2025 Release
April 2025 Release (Version 0.69.1)
Update 0.69.1: This update addresses the following issues.
- OKIT-Classic: Missed updates from okitweb to okitserver
Welcome to the April 2025 release of OKIT. This release restructures the git repository to clearly identify Classic code.
OKIT Classic Features
- OKIT-Classic: (OKIT-321) Restructure Repository to move exist OKIT files to okitclassinc Subdirectory.
- This modification will require any existing users to change their environment variables and any start scripts they use. The documentation and associated scripts within the repository have been updated and the user must follow the new instructions.April 2025 Release
April 2025 Release (Version 0.69.0)
Update 0.69.0: This update addresses the following issues.
Welcome to the April 2025 release of OKIT. This release extends the number of resources supported within OKIT-Desktop whilst restructuring the git repository to clearly identify Classic code.
OKIT Classic Features
- OKIT-Classic: (OKIT-321) Restructure Repository to move exist OKIT files to okitclassinc Subdirectory.
- This modification will require any existing users to change their environment variables and any start scripts they use. The documentation and associated scripts within the repository have been updated and the user must follow the new instructions.OKIT Desktop Features
- OKIT-Desktop: Add new OCI Resources
- Bastion (OKIT-322)
- Vault (OKIT-323)
- Key (OKIT-324)
- Secret (OKIT-325)
- Data Science Project (OKIT-331)
- Data Science Notebook Session (OKIT-332)
- Integration Instance (OKIT-333)
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 addition 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 removed and as such Compartment are no longer 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 | ✓ | ✓ | |||
| Bastion | ✓ | ✓ | |||
| Vault | ✓ | ✓ | |||
| Key | ✓ | ✓ | |||
| Secret | ✓ | ✓ | |||
| Data Science Project | ✓ | ✓ | |||
| Data Science Notebook Session | ✓ | ✓ | |||
| Integration Instance | ✓ | ✓ |
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 okay 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.
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 palette 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 editable properties available for the selected Resource. In addition the User can provide Resource specific documentation that will be included in any generated Markdown.
March 2025 Release
March 2025 Release (Version 0.68.0)
Update 0.68.0: This update addresses the following issues.
Welcome to the March 2025 release of OKIT. This release extends both import and export functions of the OCD Desktop rlease whilst adding token based authentication.
OKIT Classic Features
- OKIT-Classic: Remove optional compartment_id from Object Storage namespace query in Terraform
OKIT Desktop Features
- OKIT-320: Import Terraform Files. This is the initiall release of the Terraform import functionality and may need updates as and when issues are seen.
- OKIT-301: Add export to Excel (Detailed)
- OKIT-319: Add security Token based authentication. If during authentication OKIT Desktop notices the presence of a security token entry in the config file it will switch to token based authentication.
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.
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.
January 2025 Release
January 2025 Release (Version 0.67.0)
Update 0.67.0: This update addresses the following issues.
Welcome to the January 2025 release of OKIT. This release updates a number of embedded JavaScript libraries to their latest release..
OKIT (Web) Features
- OKIT-Web: Update D3 library to V7
- OKIT-Web: Update JQuery to V3.7.1
OKIT - Open Cloud Designer
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.
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.
November 2024 Patch
November 2024 Release (Version 0.66.1)
Update 0.66.1: This update addresses the following issues.
- 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
- OKIT-Ocd: Convert @ocd/core to ES6 Module (#OKIT-307)
- OKIT-Ocd: Convert @ocd/model to ES6 Module (#OKIT-308)
- OKIT-Ocd: Convert @ocd/query to ES6 Module (#OKIT-309)
- OKIT-Ocd: Convert @ocd/export to ES6 Module (#OKIT-310)
- OKIT-Ocd: Convert @ocd/import to ES6 Module (#OKIT-311)
- OKIT-Ocd: Convert @ocd/codegen to ES6 Module (#OKIT-312)
- OKIT-Ocd: Convert @ocd/codegen-cli to ES6 Module (#OKIT-313)
- OKIT-Ocd: Convert @ocd/cli to ES6 Module (#OKIT-314)
- OKIT-Ocd: Convert @ocd/desktop to ES6 Module (#OKIT-315)
- OKIT-Ocd: Switch build process from Create React App / Webpack to Vite (#OKIT-305)
- 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.
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.
November 2024 Release
November 2024 Release (Version 0.66.0)
Update 0.66.0: This update addresses the following issues.
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
- OKIT-Ocd: Convert @ocd/core to ES6 Module (#OKIT-307)
- OKIT-Ocd: Convert @ocd/model to ES6 Module (#OKIT-308)
- OKIT-Ocd: Convert @ocd/query to ES6 Module (#OKIT-309)
- OKIT-Ocd: Convert @ocd/export to ES6 Module (#OKIT-310)
- OKIT-Ocd: Convert @ocd/import to ES6 Module (#OKIT-311)
- OKIT-Ocd: Convert @ocd/codegen to ES6 Module (#OKIT-312)
- OKIT-Ocd: Convert @ocd/codegen-cli to ES6 Module (#OKIT-313)
- OKIT-Ocd: Convert @ocd/cli to ES6 Module (#OKIT-314)
- OKIT-Ocd: Convert @ocd/desktop to ES6 Module (#OKIT-315)
- OKIT-Ocd: Switch build process from Create React App / Webpack to Vite (#OKIT-305)
- 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.
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.