diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000000000000000000000000000000000000..e84d11fa79f41d2cb7e3dab037f43ffa13940839 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,22 @@ +ARG BASE_REGISTRY=registry1.dsop.io +ARG BASE_IMAGE=ironbank/redhat/ubi/ubi8 +ARG BASE_TAG=8.2 + +FROM istio/istioctl:1.7.0 AS base + +FROM ${BASE_REGISTRY}/${BASE_IMAGE}:${BASE_TAG} + +LABEL org.opencontainers.image.title="istioctl" \ + org.opencontainers.image.description="Istio configuration command line utility." \ + org.opencontainers.image.licenses="Apache-2.0" \ + org.opencontainers.image.url="https://istio.io" \ + org.opencontainers.image.version="1.7.0" \ + maintainer="cht@dsop.io" + +COPY --from=base /usr/local/bin/istioctl /usr/local/bin/istioctl + +USER 1000 + +HEALTHCHECK --interval=1m --start-period=30s CMD version --remote=false + +ENTRYPOINT ["/usr/local/bin/istioctl"] diff --git a/Jenkinsfile b/Jenkinsfile new file mode 100644 index 0000000000000000000000000000000000000000..6ed32760c1f46cbb7a333d9337e66d0dbe81241d --- /dev/null +++ b/Jenkinsfile @@ -0,0 +1,2 @@ +@Library('DCCSCR@master') _ +dccscrPipeline(version: "1.7.0") \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000000000000000000000000000000000000..83499274bfc8dce9ec26308ef93d2d0ae9088f4f --- /dev/null +++ b/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "{}" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2016-2019 Istio Authors + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + diff --git a/README.md b/README.md index 7d1221de940b03636b174439cd8084e745815cde..037ab6fcd4c7627ec831f39ce7c5ff89ec40adf0 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,86 @@ -# istioctl-1.7 +# istioctl +istioctl allows you to install and configure an Istio mesh for production use or for evaluation purposes. istioctl is a command line tool which provides customization of the Istio control plane and of the sidecars for the Istio data plane. It has user input validation to help prevent installation errors and customization options to override any aspect of the configuration. + +The default method for installing and configuring the Istio service mesh used to be done with Helm 2.x. However, this method is now discouraged and Istio instead encourages developers to install using istioctl or the Istio Operator. istioctl can utilize the Operator and you will need to use the Iron Bank hardened istioctl container in the Operator deployment. + +The repository for the Operator can be found here: + +[https://repo1.dsop.io/dsop/opensource/istio-1.7/operator-1.7](https://repo1.dsop.io/dsop/opensource/istio-1.7/operator-1.7) + +A good starting point for the Istio Operator is the post from the official Istio blog introducing the Operator (keep in mind that the post was written before the release of Istio 1.6.0, so some of the information could possibly be outdated): + +https://istio.io/blog/2019/introducing-istio-operator/ + + +istioctl generates an installation manifest which depends on the configuration flags that are passed in via the istioctl command line. For a full list of the istioctl commands and associated flags, please refer to the following: + +https://istio.io/docs/reference/commands/istioctl/ + + +For more information on installing and utilizing istioctl, please refer to the following page: + +https://istio.io/docs/setup/install/istioctl/ + + +## Downloading and building istioctl from the Iron Bank +1. Go to the webpage for istioctl in the Iron Bank and download the tarball. +2. Navigate to the location of the download and run `docker load -i *tarball.tar.gz* -t istioctl:*tag*` or `podman load -i *tarball.tar.gz* -t istioctl:*tag*`, substituting in the appropriate download name. This will build the image that will be used when the container runs. Provide a unique tag so that it is easy to reference the image later. + + +## Download the necessary Istio images from the Iron Bank + +1. Determine which Istio-related images need to be obtained from the Iron Bank. + +istioctl uses configuration profiles for installing in a cluster. This is done by passing in the configuration in the command line. For example, if applying the demo configuration profile, you would add `--set profile=demo` when applying the manifest. The configuration profiles vary; they each contain different configuration instructions/resources which are installed. In order to view the available configuration profiles, run the following command: + +`istioctl profile list` + +Display the configuration settings of a profile using the following command (demo is used as an example): + +`istioctl profile dump demo` + +This command will display the components which are enabled for that particular configuration profile. For example, the demo profile utilizes the grafana, kiali, prometheus, and jaeger-all-in-one containers. If you are intending on using these components with Istio, you will need to download the tarball for these images from the Iron Bank and follow the steps for building and tagging the images from their respective Repo One repositories. + +## Install Istio from external charts +istioctl uses charts that are compiled into the binary by default when generating the install manifest. However, these charts utilize the Istio containers from the public Docker Hub container images repository. +As the Iron Bank does not currently have a container image repository to reference, you must utilize one of the following workarounds: + +1. This workaround is the preferred option due to its simplicity compared to the second one. If you have access to a private container image repository (Artifactory, Nexus, etc.), you can point to the private repository when generating the manifest, so that the images that are referenced are pulled from this repository. + +First, you must download the container images used by the Istio installation profile from the Iron Bank and tag them and push them up to your repository. You can put them in a single folder in order to reference them more easily. + +Then, generate the manifest by running the following command: + +`istioctl manifest generate --set hub=*private.registry.address* > output/path/generated-manifest.yaml` + +Substitute in the address for the private registry and the desired output path for the manifest on the local machine. + +You can then apply this manifest using the following command: + +`kubectl apply -f output/path/generated-manifest.yaml` + +This ensures that the hub being used as a source for image-pulling is the private container registry and not the public Docker Hub repo. + +2. The second workaround requires a deeper dive into the code and requires you to download the Istio from the releases page: + +[https://github.com/istio/istio/releases/tag/1.7.0](https://github.com/istio/istio/releases/tag/1.7.0) + +Un-tar the download file and move it to the location on the machine of your choice. + +As in the first step, you must also download the container images used by the Istio installation profile from the Iron Bank and tag them. Provide unique tags so the images can be referenced more easily. + +Navigate to the `install/kubernetes/operator/charts` directory. You will see various folders that each relate to the components which can be deployed based upon the installation profile. You must go through each directory for the various components and substitute in the existing image tags with the ones you have downloaded and tagged from the Iron Bank. This will tell the operator to utilize the local, hardened images. + +In order to use these external charts, run the following command (this example is using the default profile): + +`istioctl manifest apply --set installPackagePath=< path to istio releases >/istio-1.7.0/install/kubernetes/operator/charts \ + --set profile=< path to istio releases >/istio-1.7.0/install/kubernetes/operator/profiles/default.yaml` + +You should then see the Iron Bank container images used in the Istio deployment. + +For more information, refer to the istioctl installation documentation referenced above. + +## Notes + +The container runs as user 1000. diff --git a/download.yaml b/download.yaml new file mode 100644 index 0000000000000000000000000000000000000000..b646af77620f8deb3d954dc2b3462e10509d9c61 --- /dev/null +++ b/download.yaml @@ -0,0 +1,4 @@ +--- +resources: + - url: "docker://docker.io/istio/istioctl@sha256:f850301d60712170daf22b3b7358343928944dde08c4f2bbe57724287625f278" + tag: "istio/istioctl:1.7.0" \ No newline at end of file diff --git a/renovate.json b/renovate.json new file mode 100644 index 0000000000000000000000000000000000000000..5679b8bb1663c032b7928623f5d51913bc7f211d --- /dev/null +++ b/renovate.json @@ -0,0 +1,32 @@ +{ + "assignees": ["@bhearn"], + "baseBranches": ["development"], + "packageRules": [ + { + "datasources": ["docker"], + "packageNames": ["istio/istioctl"], + "separateMinorPatch": true, + "minor": { + "enabled": false + } + } + ], + "regexManagers": [ + { + "fileMatch": ["^Dockerfile$"], + "matchStrings": [ + "version=\"(?.*?)\"" + ], + "depNameTemplate": "istio/istioctl", + "datasourceTemplate": "docker" + }, + { + "fileMatch": ["^Jenkinsfile$"], + "matchStrings": [ + "version:\\s+\"(?.*?)\"" + ], + "depNameTemplate": "istio/istioctl", + "datasourceTemplate": "docker" + } + ] +}