{"id":18708848,"url":"https://github.com/oracle-actions/configure-kubectl-oke","last_synced_at":"2025-04-12T10:34:54.921Z","repository":{"id":63381241,"uuid":"381305535","full_name":"oracle-actions/configure-kubectl-oke","owner":"oracle-actions","description":"Install and configure Kubectl for the specified Oracle Engine for Kubernetes (OKE) cluster","archived":false,"fork":false,"pushed_at":"2024-12-09T05:58:14.000Z","size":1847,"stargazers_count":15,"open_issues_count":3,"forks_count":10,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-21T05:33:02.752Z","etag":null,"topics":["actions","github-actions","oke","oracle-cloud","oracle-cloud-infrastructuure"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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-actions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","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":"2021-06-29T09:12:36.000Z","updated_at":"2025-02-18T02:57:04.000Z","dependencies_parsed_at":"2024-05-31T02:26:11.519Z","dependency_job_id":"da8388ed-02ee-4cab-9eb5-8fffebd9c76c","html_url":"https://github.com/oracle-actions/configure-kubectl-oke","commit_stats":{"total_commits":30,"total_committers":3,"mean_commits":10.0,"dds":0.1333333333333333,"last_synced_commit":"ff6f12184dbf6270f00217fe0ca1670442e81511"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-actions%2Fconfigure-kubectl-oke","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-actions%2Fconfigure-kubectl-oke/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-actions%2Fconfigure-kubectl-oke/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oracle-actions%2Fconfigure-kubectl-oke/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oracle-actions","download_url":"https://codeload.github.com/oracle-actions/configure-kubectl-oke/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248553799,"owners_count":21123521,"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":["actions","github-actions","oke","oracle-cloud","oracle-cloud-infrastructuure"],"created_at":"2024-11-07T12:25:25.072Z","updated_at":"2025-04-12T10:34:54.364Z","avatar_url":"https://github.com/oracle-actions.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Configure `kubectl` for Oracle Container Engine for Kubernetes\n\nUse this GitHub Action to install and configure `kubectl` to connect to the specified [Oracle Container Engine for\nKubernetes][1] (OKE) cluster.\n\n## Prerequisites\n\nThe target OKE cluster must have a **public Kubernetes API Endpoint** in order for a standard GitHub Action workflow to\nsuccessfully connect to the cluster. To access an OKE cluster with a private Kubernetes API endpoint, you must deploy a\n[self-hosted GitHub Runner][6] to an Oracle Cloud Infrastructure (OCI) compute instance on the same private subnet as\nthat endpoint.\n\nThe following [OCI CLI environment variables][2] must be defined for the workflow:\n\n- `OCI_CLI_USER`\n- `OCI_CLI_TENANCY`\n- `OCI_CLI_FINGERPRINT`\n- `OCI_CLI_KEY_CONTENT`\n- `OCI_CLI_REGION`\n\nWe recommend using GitHub Secrets to store these values. [Defining your environment variables][3] at the job or workflow\nlevel would allow multiple tasks/jobs to reduce duplication.\n\n## Inputs\n\n- `cluster`: (Required) The OCID of the OKE cluster to configure\n- `enablePrivateEndpoint`: (Optional) set this to 'true' if you need to connect to a private Kubernetes API endpoint.\n  Requires a self-hosted GitHub Runner deployed to an instance on the same private subnet. Default: false\n\n## Sample workflow steps\n\nThe following sample workflow configures `kubectl` for the `OKE_CLUSTER_OCID` OKE cluster using **public** API Endpoint.\n\n```yaml\njobs:\n  install-kubectl:\n    runs-on: ubuntu-latest\n    name: Install Kubectl for OKE\n    env:\n      OCI_CLI_USER: ${{ secrets.OCI_CLI_USER }}\n      OCI_CLI_TENANCY: ${{ secrets.OCI_CLI_TENANCY }}\n      OCI_CLI_FINGERPRINT: ${{ secrets.OCI_CLI_FINGERPRINT }}\n      OCI_CLI_KEY_CONTENT: ${{ secrets.OCI_CLI_KEY_CONTENT }}\n      OCI_CLI_REGION: ${{ secrets.OCI_CLI_REGION }}\n\n    steps:\n      - name: Configure Kubectl\n        uses: oracle-actions/configure-kubectl-oke@v1.5.0\n        id: test-configure-kubectl-oke-action\n        with:\n          cluster: ${{ secrets.OKE_CLUSTER_OCID }}\n\n      - name: Run Kubectl\n        run: kubectl get nodes -A\n```\n\nThe following sample workflow configures `kubectl` for the `OKE_CLUSTER_OCID` OKE cluster using **private** API Endpoint\nby adding `runs-on: self-hosted` to ensure this action runs on your self-hosted GitHub Runner. It also sets\n`enablePrivateEndpoint` to `true` to ensure the `kubeconfig` file contains the correct Kubernetes API information.\n\n```yaml\njobs:\n  install-kubectl:\n    runs-on: self-hosted\n    name: Install Kubectl for OKE\n    env:\n      OCI_CLI_USER: ${{ secrets.OCI_CLI_USER }}\n      OCI_CLI_TENANCY: ${{ secrets.OCI_CLI_TENANCY }}\n      OCI_CLI_FINGERPRINT: ${{ secrets.OCI_CLI_FINGERPRINT }}\n      OCI_CLI_KEY_CONTENT: ${{ secrets.OCI_CLI_KEY_CONTENT }}\n      OCI_CLI_REGION: ${{ secrets.OCI_CLI_REGION }}\n\n    steps:\n      - name: Configure Kubectl\n        uses: oracle-actions/configure-kubectl-oke@v1.5.0\n        id: test-configure-kubectl-oke-action\n        with:\n          cluster: ${{ secrets.OKE_CLUSTER_OCID }}\n          enablePrivateEndpoint: true\n\n      - name: Run Kubectl\n        run: kubectl get nodes -A\n```\n\n## Contributing\n\nWe welcome contributions from the community. Before submitting a pull request, please [review our contribution\nguide][4].\n\n## Security\n\nPlease consult the [security guide][5] for our responsible security vulnerability disclosure process.\n\n## License\n\nCopyright (c) 2021, 2023, Oracle and/or its affiliates.\n\nReleased under the Universal Permissive License v1.0 as shown at \u003chttps://oss.oracle.com/licenses/upl/\u003e.\n\n[1]: https://www.oracle.com/cloud-native/container-engine-kubernetes/\n[2]: https://docs.oracle.com/en-us/iaas/Content/API/SDKDocs/clienvironmentvariables.htm\n[3]: https://docs.github.com/en/actions/learn-github-actions/environment-variables\n[4]: /CONTRIBUTING.md\n[5]: ./SECURITY.md\n[6]: https://docs.github.com/en/actions/hosting-your-own-runners\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle-actions%2Fconfigure-kubectl-oke","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foracle-actions%2Fconfigure-kubectl-oke","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foracle-actions%2Fconfigure-kubectl-oke/lists"}