Merge pull request #734 from oracle/733-update-main-readme-to-de-emph…

…asise-docker

733 update main readme to de emphasise docker

CHANGELOG.md

@@ -1,6 +1,13 @@
 # Release Notes
 
 
+## Version 0.66.1
+**Release Date**: 13th December 2024
+### Features
+### Bug Fixes
+1. Update main README to de-emphasise Docker (Issue: #733)
+
+
 ## Version 0.66.0
 **Release Date**: 30th November 2024
 ### Features

Dockerfile

@@ -6,7 +6,7 @@ FROM oraclelinux:8
 ARG BRANCH=master
 LABEL "provider"="Oracle" \
       "issues"="https://github.com/oracle/oci-designer-toolkit/issues" \
-      "version"="0.66.0" \
+      "version"="0.66.1" \
       "description"="OKIT Web Server Container." \
       "copyright"="Copyright (c) 2020, 2024, Oracle and/or its affiliates."
 # SHELL ["/bin/bash", "-c"]

README.md

@@ -1,9 +1,9 @@
 [![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&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=oracle_oci-designer-toolkit)
-# Oracle Cloud Infrastructure Designer and Visualisation Toolkit [0.66.0](CHANGELOG.md#version-0.66.0)
+# Oracle Cloud Infrastructure Designer and Visualisation Toolkit [0.66.1](CHANGELOG.md#version-0.66.1)
 
-Full Release Details Can Found [0.66.0 Release](https://github.com/oracle/oci-designer-toolkit/releases/tag/v0.66.0).
+Full Release Details Can Found [0.66.1 Release](https://github.com/oracle/oci-designer-toolkit/releases/tag/v0.66.1).
 
-**OKIT - Open Cloud Designer** Public Beta is now Available see [0.66.0 Release](https://github.com/oracle/oci-designer-toolkit/releases/tag/v0.66.0) for details.
+**OKIT - Open Cloud Designer** Public Beta is now Available see [0.66.1 Release](https://github.com/oracle/oci-designer-toolkit/releases/tag/v0.66.1) for details.
 _____
 
 OCI designer and visualisation toolKIT (OKIT) is a browser based tool that allows the user to [design](https://www.ateam-oracle.com/introduction-to-okit-the-oci-designer-toolkit), 
@@ -38,7 +38,7 @@ OCI environments through a graphical web based interface.
 
 ## Changes
 
-[Changes for the current release (0.66.0) are documented here.](CHANGELOG.md#version-0.66.0)
+[Changes for the current release (0.66.1) are documented here.](CHANGELOG.md#version-0.66.1)
 
 
 ## Releases
@@ -54,46 +54,26 @@ See [Releases](https://github.com/oracle/oci-designer-toolkit/releases)
 
 
 ## Installation
+### OKIT-Web
 Detailed OKIT Installation steps can be found in the [OCI Designer Toolkit Installation Guide](documentation/Installation.md).
+1. [MacOS](documentation/Installation.md#macos)
+2. [Windows 10 / WSL (Ubuntu)](documentation/Installation.md#windows-10--wsl-ubuntu)
+3. [Oracle Linux](documentation/Installation.md#oracle-linux-ol8)
+### 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](https://github.com/oracle/oci-designer-toolkit/releases/tag/v0.66.1).
+1. MacOS
+    1. [Arm dmg](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.66.1/ocd-0.2.6-arm64.dmg)
+    2. [x64 dmg](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.66.1/ocd-0.2.6-x64.dmg)
+2. Windows
+    1. [Setup](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.66.1/ocd-0.2.6-Setup.exe)
+3. Linux
+    1. [rpm](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.66.1/ocd-0.2.6-1.x86_64.rpm)
+    2. [deb](https://github.com/oracle/oci-designer-toolkit/releases/download/v0.66.1/ocd_0.2.6_amd64.deb)
 
-_Note:_ [For instructions on installing OKIT on an OCI Instance follow the instructions within the Installation guide.](documentation/Installation.md#install-on-oci-instance)
 
 
-### Runtime Quick Start
-[Docker](https://www.docker.com/products/docker-desktop) is the recommended runtime container for OKIT. The project contains a top-level Dockerfile to facilitate direct
-building, of the runtime environment, from the docker command line.
-
-#### Prerequisites 
-Before building / running OKIT you will need to install [Docker / Docker Desktop](https://www.docker.com/products/docker-desktop).
-
-#### Build Docker Container
-```bash
-docker build --tag okit --no-cache --force-rm https://github.com/oracle/oci-designer-toolkit.git
-```
-_Note:_ [If you are running on Windows and see issues please follow the docker clone/build from source instructions.](documentation/Installation.md#build-from-source)
-
-#### Create / Generate Connection Information
-If you already have the OCI sdk/cli installed on you machine you can use the previously generated pem key and config file
-we will assume that this exists in <USER HOME DIR>/.oci 
-
-##### Key File
-
-If you do not have a previously generated private key you will need to create a private/public key pair for use with OKIT and OCI.
-These keys can be generated using the following commands as defined in [Required Keys and OCIDs](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm).
-
-```bash
-openssl genrsa -out <USER HOME DIR>/.oci/oci_api_key.pem 2048   
-openssl rsa -pubout -in <USER HOME DIR>/.oci/oci_api_key.pem -out <USER HOME DIR>/.oci/oci_api_key_public.pem                                  
-```
-
-Upload the generated __oci_api_key_public.pem__ to OCI through the [console](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm) and record the associated fingerprint following upload.
-
-###### Get Fingerprint
-```bash
-openssl rsa -pubout -outform DER -in ~/.oci/oci_api_key.pem | openssl md5 -c
-```
-
-##### OCI Config File
+### OCI Config File
 
 Create the OCI cli __config__ file in the directory __&lt;USER HOME DIR&gt;/.oci__ with contents similar to that below.
 The __*key_file*__ is a fixed value because the contents of the __&lt;USER HOME DIR&gt;/.oci__ will be mounted to the
@@ -108,7 +88,13 @@ tenancy=ocid1.tenancy.oc1..aaaaaaaawpqblfem........
 region=us-phoenix-1
 ```
 
-##### GIT Settings File
+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.
+```properties
+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 
 __&lt;USER HOME DIR&gt;/.oci__ with contents similar to that below.
@@ -137,25 +123,6 @@ Host github.com
 ```
 
 
-#### Run Container
-
-##### Simple
-```bash
-docker run -d --rm -p 80:80 --volume <USER HOME DIR>/.oci:/root/.oci --volume <USER HOME DIR>/.ssh:/root/.ssh --name okit okit
-```
-
-##### Mount User Templates and Git Directories
-```bash
-docker run -d --rm -p 80:80 --volume <USER HOME DIR>/.oci:/root/.oci --volume <USER HOME DIR>/.ssh:/root/.ssh --volume <PATH TO USER TEMPLATES DIR>:/okit/instance/templates/user --volume <PATH TO GIT DIR>:/okit/instance/git --volume <PATH TO LOCAL DIR>:/okit/instance/local --name okit okit
-```
-
-__Note:__ Occasionally Docker Container may have clock drift and this can cause authentication issues this can be resolved by executing.
-```bash
-docker run --rm --privileged okit hwclock -s
-```
-
-Once started the Designer BUI can be accessed on [http://localhost/okit/designer](http://localhost/okit/designer)
-
 ## Usage / Examples
 The OKIT User / Usage Guide and worked examples can be found in the [OCI Designer Toolkit Usage Guide](documentation/Usage.md)
 

RELEASE_NOTES.md

@@ -1,7 +1,8 @@
 [![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&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=oracle_oci-designer-toolkit)
-# November 2024 Release (Version 0.66.0)
+# November 2024 Release (Version 0.66.1)
 ____
-**Update 0.66.0**: This update addresses the following issues.
+**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.
 

containers/docker/Dockerfile

@@ -5,7 +5,7 @@
 FROM oraclelinux:8
 LABEL "provider"="Oracle" \
       "issues"="https://github.com/oracle/oci-designer-toolkit/issues" \
-      "version"="0.66.0" \
+      "version"="0.66.1" \
       "description"="OKIT Web Server Container." \
       "copyright"="Copyright (c) 2020, 2024, Oracle and/or its affiliates."
 # SHELL ["/bin/bash", "-c"]

documentation/Build.md

@@ -0,0 +1,34 @@
+# OCI Designer Toolkit Installation Guide
+## Build from Source
+
+### OKIT Repository
+Before the building either the Docker or Vagrant Images the project will need to be cloned, or downloaded, from the GitHub 
+Repository.  
+
+#### Clone
+The command shows how this can be cloned to the local machine.
+
+```bash
+git clone -c core.autocrlf=input [email protected]:oracle/oci-designer-toolkit.git
+```
+
+or 
+
+```bash
+git clone -c core.autocrlf=input https://github.com/oracle/oci-designer-toolkit.git
+```
+
+#### Update
+If you have previously cloned the GitHub Repository you can update to the latest release by pulling it from the repository 
+with the following command.
+
+```bash
+cd oci-designer-toolkit
+git pull
+```
+
+#### Download
+If you do not have git installed locally the current release of OKIT can be retrieved by downloading it as a zip file from
+[https://github.com/oracle/oci-designer-toolkit/archive/master.zip](https://github.com/oracle/oci-designer-toolkit/archive/master.zip)
+
+