oracle-samples / oci-vscode-toolkit Goto Github PK

OCI Toolkit for VSCode - Functions, Data Science, Resource Manager

Home Page: https://marketplace.visualstudio.com/items?itemName=Oracle.oci-vscode-toolkit

License: Universal Permissive License v1.0

JavaScript 6.79% CSS 0.55% Dockerfile 1.01% Java 6.37% Python 11.36% Go 0.52% Ruby 0.24% Kotlin 0.12% TypeScript 72.80% HTML 0.25%

datascience functions oci oracle-cloud resource-management vscode vscode-extension oracle vscode-extension-pack

oci-vscode-toolkit's Introduction

OCI Toolkit for VS Code

OCI Toolkit for VS Code is a rich collection of OCI extensions, making it easier for you to develop, test, and deploy applications on Oracle Cloud Infrastructure (OCI) straight from VS Code.

OCI toolkit for VS Code is available from the Visual Studio Marketplace

OCI Services

Resource Manager extension allows you to edit, plan and deploy Resource Manager Configurations stored in Object Storage or a Code repository. For more information, see the Resource Manager Walkthrough
Functions extension in the VS Code lets you create a new function, edit an existing function and deploy and invoke it. For more information, see the Functions Walkthrough
Data Science extension allows you to edit your job artifacts and run Data Science jobs natively. For more information, see the Data Science Walkthrough
OCI CLI allows users to perform common platform actions, such as creating and managing OCI resources using the built-in OCI CLI in the VS Code terminal

Installation

Installing the OCI VS Code toolkit installs all of the extensions along with the OCI Core extension

You can easily uninstall individual extensions if you are not interested in using them, without affecting other extensions provided by this pack. Additionally, you can uninstall all of the extensions by uninstalling the OCI VS Code toolkit extension.

Minimum policies required

Allow group to inspect compartments in tenancy

Sign-In

The plugin requires basic configuration information, like user credentials and tenancy OCID. This information should be present in a configuration file located at ~/.oci/config

There are two ways to get the config file

Auto-generate file using Sign In Button:

On successful login, a config file will be generated and saved in ~/.oci folder
Manually generate a file and save it in the ~/.oci folder:

Details on generating the configuration file can be found here

Switch-Region

The user can switch to different subscribed OCI regions from this wizard.

OCI CLI

The OCI Toolkit for VS Code comes with the OCI CLI. Users can effortlessly perform common platform actions, such as creating and managing OCI resources using the built-in OCI CLI in the VS Code terminal. Further, leverage the OCI CLI's interactive mode to simplify resource management tasks with command and parameter suggestions, auto-completing, and command reference information.

Enable interactive mode on your terminal with the below command from the Command Palette:

Toggle Interactive CLI

Documentation

Full documentation, including prerequisites, supported vscode versions and configuration instructions, is available here.

Contributing

This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide

Security

Please consult the security guide for our responsible security vulnerability disclosure process

License

Copyright (c) 2022, 2024, Oracle and/or its affiliates. All rights reserved.This software is licensed to you under the Universal Permissive License (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl.

See LICENSE for more details.

oci-vscode-toolkit's People

Contributors

Stargazers

Watchers

Forkers

snaraya7 brett2uk

oci-vscode-toolkit's Issues

Extension Oracle.faas has provided an invalid tree item.

I am trying to create a new function. After selecting create from template and giving a function name, its not giving the option to select repository.
Its throwing this error
Extension Oracle.faas has provided an invalid tree item.

Switching Region and Profile

If ~/.oci/config has multiple profiles, the extension doesn't seem to allow switching unless going into the settings and changing the "default profile name" to what is needed. Changing either the region or profile from VS Code and refreshing the Resource Manager tree seems to load only the stacks from the default profile that was in the extension config.

Trying to configure an application results in "command 'faas.ociConfigurationApplicationRootNode' not found..."

Created an app successfully.
then tried to configure by clicking on the "config" icon
got error message "command 'faas.ociConfigurationApplicationRootNode' not foun"

Thanks
Michel

If SDK config file has inline comments all plug-ins will fail (Functions, Data Science, Resource Manager)

v1.0.5

I had ~/.oci/config that looked like this that caused the error

[mytenancy]
user=ocid1.user.oc1..abcdefghijklmnop
fingerprint=00:DE:AD:BE:EF:00
tenancy=ocid1.tenancy.oc1..abcdefghijklmnop
region=us-ashburn-1
key_file=~/.oci/mykey.pem

[mytenancy-user2] #same as mytenancy but user2 OCID
user=ocid1.user.oc1..zyxwvutsrqponmlk
fingerprint=00:DE:AD:BE:EF:00
tenancy=ocid1.tenancy.oc1..abcdefghijklmnop
region=us-ashburn-1
key_file=~/.oci/mykey.pem

When I changed above inline comment to this all was well:

[mytenancy]
user=ocid1.user.oc1..abcdefghijklmnop
fingerprint=00:DE:AD:BE:EF:00
tenancy=ocid1.tenancy.oc1..abcdefghijklmnop
region=us-ashburn-1
key_file=~/.oci/mykey.pem

#same as mytenancy but user2 OCID
[mytenancy-user2]
user=ocid1.user.oc1..zyxwvutsrqponmlk
fingerprint=00:DE:AD:BE:EF:00
tenancy=ocid1.tenancy.oc1..abcdefghijklmnop
region=us-ashburn-1
key_file=~/.oci/mykey.pem

Here is the error. I could not find the means to get any sort of output for debugging. Glad to know if there is a way (for future reference). As I say, once I moved the comment line above to its own line instead of inline with the profile name it worked.

test

Edit function Setting - error "Memory Of function Not defined"

Edit function Setting - results in an error popup : "Memory Of function Not defined"

question on OCI CLI configuration

I already have the OCI CLI installed on my workstation via pip.
After I installed VS Code toolkit, I keeps asking me if I want to install the OCI CLI as part of the toolkit

Is there a way to disable this and still have the CLI integration functioning within VS Code?
The installation was done in the default directories and are the same as the integration has as default.
So would actually expect the integration to notice that these are already installed