Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oracle-actions/run-oci-cli-command

Run Oracle Cloud Infrastructure (OCI) CLI commands
https://github.com/oracle-actions/run-oci-cli-command

actions github-actions oci-cli oracle-cloud oracle-cloud-infrastructure

Last synced: about 1 month ago
JSON representation

Run Oracle Cloud Infrastructure (OCI) CLI commands

Host: GitHub
URL: https://github.com/oracle-actions/run-oci-cli-command
Owner: oracle-actions
License: upl-1.0
Created: 2021-06-29T09:25:21.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-11-17T08:03:51.000Z (2 months ago)
Last Synced: 2024-12-06T07:03:59.466Z (about 2 months ago)
Topics: actions, github-actions, oci-cli, oracle-cloud, oracle-cloud-infrastructure
Language: TypeScript
Size: 773 KB
Stars: 28
Watchers: 5
Forks: 9
Open Issues: 5
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md

Awesome Lists containing this project

README

# run-oci-cli-command

This GitHub Action installs the OCI CLI and then runs the specified command. This action will automatically cache the
OCI CLI install to speed up any subsequent steps that use this action.

## Required environment variables

The following [OCI CLI environment variables][1] must be defined for at least the `run-oci-cli-command` task:

- `OCI_CLI_USER`
- `OCI_CLI_TENANCY`
- `OCI_CLI_FINGERPRINT`
- `OCI_CLI_KEY_CONTENT`
- `OCI_CLI_REGION`

We recommend using GitHub Secrets to store these values. If you have more than one `run-oci-cli-command` task, consider
[defining your environment variables][2] at the job or workflow level.

## Inputs

- `command` (required): the [command and arguments][3] to provide to the `oci` tool.
- `query`: (optional) a [JMESPath query][4] to run on the response JSON before output.

### Output masking

By default, the output(s) from the command are masked from the GitHub Actions log and GitHub console, to prevent leaking
any credential or confidential information. The following option will disable that masking and is intended for debugging
purposes only:

- `silent`: (Optional; default: _true_) If set to _false_ the action will not mask or suppress the command or outputs
from the logs or console.

> **Note:** the output does not need to be visible in the log to be used as an input by another task.

## Outputs

- `output`: will contain the results of the command.
- `raw_output`: if the output of a given query is a single string value, `raw_output` will return the string without
surrounding quotes.

> **Note:** filtering the `output` or `raw_output` by piping it through another tool like `jq` may result in the
> filtered output being visible in the job logs. We recommend using the `query` parameter whenever possible.

If the result of the command is not valid JSON, it will not be visible unless `silent` is set to _false_.

## Sample workflow

The following example lists all compute instances found in the `testing` compartment of the `OCI_CLI_TENANCY` in the
`OCI_CLI_REGION` region.

To change the name of the compartment, modifying the `query` parameter of the `find-compartment-id` step.

To change which fields are returned, modify the `query` parameter of the `find-instances` step.

```yaml
jobs:
my-instances:
runs-on: ubuntu-latest
name: List the display name and shape of the instances in my compartment
env:
OCI_CLI_USER: ${{ secrets.OCI_CLI_USER }}
OCI_CLI_TENANCY: ${{ secrets.OCI_CLI_TENANCY }}
OCI_CLI_FINGERPRINT: ${{ secrets.OCI_CLI_FINGERPRINT }}
OCI_CLI_KEY_CONTENT: ${{ secrets.OCI_CLI_KEY_CONTENT }}
OCI_CLI_REGION: ${{ secrets.OCI_CLI_REGION }}
steps:
- name: Retrieve the OCID of a named compartment in tenancy
uses: oracle-actions/[email protected]
id: find-compartment-id
with:
command: 'iam compartment list --compartment-id-in-subtree=true'
query: "data[?name=='testing'].id"

- name: Retrieve the display name and shape of the instances in my compartment
uses: oracle-actions/[email protected]
id: find-instances
with:
command: 'compute instance list --compartment-id ${{ steps.find-compartment-id.outputs.raw_output }}'
query: 'data[*].{name: \"display-name\", shape: shape}'

- name: List the display name and shape of the instances in my compartment
run: |
echo ${{ steps.find-instances.outputs.output }} | jq .
```

Consult the [JMESPath documentation][4] for details on how to create more complex queries and result formatting and
[`action.yml`](./action.yml) for more detail on how to configure this action..

## Contributing

We welcome contributions from the community. Before submitting a pull request, please
[review our contribution guide](./CONTRIBUTING.md).

## Security

Please consult the [security guide](./SECURITY.md) for our responsible security vulnerability disclosure process.

## License

Released under the Universal Permissive License v1.0 as shown at .

[1]: https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clienvironmentvariables.htm
[2]: https://docs.github.com/en/actions/learn-github-actions/environment-variables
[3]: https://docs.oracle.com/en-us/iaas/tools/oci-cli/3.2.0/oci_cli_docs/
[4]: https://jmespath.org/