{"id":18554264,"url":"https://github.com/oracle/oci-designer-toolkit","last_synced_at":"2025-05-16T02:09:26.564Z","repository":{"id":39801926,"uuid":"263359717","full_name":"oracle/oci-designer-toolkit","owner":"oracle","description":"OCI designer toolKIT (OKIT) is a set of tools for enabling design, deploy and visualise OCI environments through a graphical web based interface.","archived":false,"fork":false,"pushed_at":"2024-10-29T10:58:10.000Z","size":29532,"stargazers_count":263,"open_issues_count":25,"forks_count":127,"subscribers_count":33,"default_branch":"master","last_synced_at":"2024-10-29T12:47:45.022Z","etag":null,"topics":["oci","oci-ansible","oci-cli","oci-designer","oci-terraform-modules","oci-toolkit","okit","visualise-oci-environments"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"upl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/oracle.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-05-12T14:24:53.000Z","updated_at":"2024-10-15T18:04:03.000Z","dependencies_parsed_at":"2024-02-12T18:27:01.806Z","dependency_job_id":"7306469f-1edd-4f39-9426-0807430fbef1","html_url":"https://github.com/oracle/oci-designer-toolkit","commit_stats":null,"previous_names":[],"tags_count":99,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Foci-designer-toolkit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Foci-designer-toolkit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Foci-designer-toolkit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle%2Foci-designer-toolkit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle","download_url":"https://codeload.github.com/oracle/oci-designer-toolkit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247847609,"owners_count":21006099,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["oci","oci-ansible","oci-cli","oci-designer","oci-terraform-modules","oci-toolkit","okit","visualise-oci-environments"],"created_at":"2024-11-06T21:20:47.513Z","updated_at":"2025-05-16T02:09:26.552Z","avatar_url":"https://github.com/oracle.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![License: UPL](https://img.shields.io/badge/license-UPL-green)](https://img.shields.io/badge/license-UPL-green) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=oracle_oci-designer-toolkit\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=oracle_oci-designer-toolkit)\n# Oracle Cloud Infrastructure Designer and Visualisation Toolkit [0.69.1](CHANGELOG.md#version-0.69.1)\n\nFull Release Details Can Found [0.69.1 Release](https://github.com/oracle/oci-designer-toolkit/releases/tag/v0.69.1).\n\n\n\n\n\n## OKIT Desktop (OCD) [0.2.9](CHANGELOG.md#version-0.69.1)\n\nOKIT Desktop is the next generation implementation of the OKIT Classic design tool that takes the concepts within OKIT Classic and re-implements them within\nan Electron based desktop application, providing native installs for Mac, Windows and Linux.\n\n**OKIT Desktop** Public Beta is now Available see [0.69.1 Release](https://github.com/oracle/oci-designer-toolkit/releases/tag/v0.69.1) for details.\n\nThe OKIT Desktop provides the user with a fully freeform Drag \u0026 Drop canvas with the ability to create multiple pages to represent the same design in alternative formats, as seen below. As with the OKIT Classic the properties of resources can be editted within the properties panel along with the ability to add detailed description of each resource, if required. The OKIT Desktop will provide feature compatibility with the OKIT Classic allowing the user multiple views of the design information:\n\n- Views\n    - Design\n    - Documentation\n    - Variables\n    - Common Tags\n    - Markdown\n    - Tabular\n    - Terraform\n\nExporting the design will now allow the following options:\n\n- Export\n    - Markdown\n    - Terraform\n    - Excel\n    - Image\n\nImporting the design will allow the following options\n- Import\n    - Query\n        - OCI\n    - Terraform\n\nThe OKIT Desktop release is also preparing for Multi-Cloud implementation of Oracle database and will be extended to include Azure, Google and AWS. This is currently Alpha release and hence limited in its functionality.\n\n### Traditional Design\n![Ocd Desktop](https://github.com/oracle/oci-designer-toolkit/blob/master/ocd/images/OcdDesktop3.png)\n### Connection Based View\n![Ocd Desktop Connections](https://github.com/oracle/oci-designer-toolkit/blob/master/ocd/images/OcdDesktop4.png)\n\n### Installation\nOKIT Desktop is the next iteration of OKIT and is currently available as a Beta release. \nThe native installables can be found in the Assets section on the [0.69.1 Release](https://github.com/oracle/oci-designer-toolkit/releases/tag/v0.69.1).\n1. MacOS\n    1. [Arm dmg](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.69.1/ocd-0.2.9-arm64.dmg)\n    2. [x64 dmg](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.69.1/ocd-0.2.9-x64.dmg)\n2. Windows\n    1. [Setup](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.69.1/ocd-0.2.9-Setup.exe)\n3. Linux\n    1. [rpm](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.69.1/ocd-0.2.9-1.x86_64.rpm)\n    2. [deb](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.69.1/ocd_0.2.9_amd64.deb)\n\nAt present the binaries are unsigned so on Mac and Windows you will specifically need to authorise the first run.\n\nFor 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.\n```bash\nxattr -d com.apple.quarantine /Applications/ocd.app\n```\n\n\n\n## OKIT Classic [0.69.1](CHANGELOG.md#version-0.69.1)\n\nOKIT Classic is the original browser based tool that allows the user to [design](https://www.ateam-oracle.com/introduction-to-okit-the-oci-designer-toolkit), \n[deploy](https://www.ateam-oracle.com/introduction-to-okit-the-oci-designer-toolkit) and visualise ([introspect/query](https://www.ateam-oracle.com/the-oci-designer-toolkit-query-feature)) \nOCI environments through a graphical web based interface. \n\n- [Design](https://www.ateam-oracle.com/introduction-to-okit-the-oci-designer-toolkit)\n\n    The Web based interface will allow architects and designers to build a visual representation of their infrastructure\n    and then export this in a number of formats. \n\n    - svg\n    - png\n    - jpeg\n\n- [Export](https://www.ateam-oracle.com/introduction-to-okit-the-oci-designer-toolkit)\n\n    Once completed the design can be enhanced to add key property information allowing the designed infrastructure to\n    be exported to a number of DevOps frameworks or Markdown for documentation.\n    \n    - Terraform\n    - OCI Resource Manager\n    - Markdown\n    \n    This allows for rapid proto-typing and building.\n\n- [Introspect](https://www.ateam-oracle.com/the-oci-designer-toolkit-query-feature)\n\n    OKIT will also allow the user to introspect existing OCI environments, through simple query functionality embedded within the\n    web interface, to provide a portable generic json file, that can be used to visualise existing systems or generate terraform/ansible.\n\n### Installation\nDetailed OKIT Installation steps can be found in the [OCI Designer Toolkit Installation Guide](okitclassic/documentation/Installation.md).\n1. [MacOS](okitclassic/documentation/Installation.md#macos)\n2. [Windows 10 / WSL (Ubuntu)](okitclassic/documentation/Installation.md#windows-10--wsl-ubuntu)\n3. [Oracle Linux](okitclassic/documentation/Installation.md#oracle-linux-ol8)\n\n\n\n\n\n## Releases\n\nSee [Releases](https://github.com/oracle/oci-designer-toolkit/releases)\n  \n\n\n\n\n## Blogs\n- [Introduction to OKIT the OCI Designer Toolkit](https://www.ateam-oracle.com/introduction-to-okit-the-oci-designer-toolkit)\n- [The OCI Designer Toolkit Templates Feature](https://www.ateam-oracle.com/the-oci-designer-toolkit-templates-feature)\n- [The OCI Designer Toolkit Query Feature](https://www.ateam-oracle.com/the-oci-designer-toolkit-query-feature)\n- [OCI Designer Toolkit Resource Manager Integration](https://www.ateam-oracle.com/oci-designer-toolkit-resource-manager-integration)\n- [The OCI Designer Toolkit Documentation Generation](https://www.ateam-oracle.com/the-oci-designer-toolkit-documentation-generation)\n\n\n\n\n\n## Usage / Examples\nThe OKIT User / Usage Guide and worked examples can be found in the [OCI Designer Toolkit Usage Guide](okitclassic/documentation/Usage.md)\n\n\n\n\n\n## Changes\n\nSee [CHANGELOG](CHANGELOG.md).\n\n\n\n\n\n## Known Issues\n\nYou can find information on any known issues with OKIT here and under the Issues tab of this project's GitHub repository.\nAny issues found with the tool should be raised on the projects issues page. Please check that the issue has not previously\nbeen reported. \n\n## Contributing\n\nThis project welcomes contributions from the community. Before submitting a pull request, please [review our contribution guide](./CONTRIBUTING.md)\n\n## Security\n\nPlease consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process\n\n## License\n\nCopyright (c) 2020, 2024, Oracle and/or its affiliates.\n\nReleased under the Universal Permissive License v1.0 as shown at\n\u003chttps://oss.oracle.com/licenses/upl/\u003e.\n\n\nIf you would like to extend OKIT the development documentation can be found in [OCI Designer Toolkit Development Guide](okitclassic/documentation/Development.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Foci-designer-toolkit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle%2Foci-designer-toolkit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle%2Foci-designer-toolkit/lists"}