diff --git a/cluster-agent-0.1.1.tgz b/cluster-agent-0.1.1.tgz index 127b1e7..27b99bf 100644 Binary files a/cluster-agent-0.1.1.tgz and b/cluster-agent-0.1.1.tgz differ diff --git a/cluster-agent/Chart.yaml b/cluster-agent/Chart.yaml index 479883d..4edde94 100644 --- a/cluster-agent/Chart.yaml +++ b/cluster-agent/Chart.yaml @@ -15,3 +15,9 @@ keywords: - monitoring - Kubernetes - OpenShift + - ICP + - DevOps + - amd64 + - Commercial +tillerVersion: ">=2.9.1" +kubeVersion: ">1.7" diff --git a/cluster-agent/LICENSE b/cluster-agent/LICENSE new file mode 100644 index 0000000..7a4a3ea --- /dev/null +++ b/cluster-agent/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 [yyyy] [name of copyright owner] + + 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. \ No newline at end of file diff --git a/cluster-agent/README.md b/cluster-agent/README.md index aae9786..318116a 100644 --- a/cluster-agent/README.md +++ b/cluster-agent/README.md @@ -8,7 +8,44 @@ This chart deploys AppDynamics ClusterAgent for monitoring Kubenetes and OpenShi * Kubernetes 1.7+ OpenShift 3.7+ * Helm and tiller installed in the cluster with the appropriate RBAC settings * Kubernetes [Metrics server](https://hub.helm.sh/charts/stable/metrics-server) installed -* An AppDynamics account. AppDynamics offers a [free trial](https://www.appdynamics.com/free-trial/) +* An AppDynamics account. + +### Create a secret +Secure and recommended approach to provide sensitive data like passwords is to generate a secret containing the sensitive data and providing the pre-created secret name during chart deployment. + +You can provide an existing secret containing `api-user` if applicable `controller-key` and `event-key`. +The existing secret can be provided as a value to `existingSecret`. + +If creating a secret, it is recommended to name the secret as `release-name`-`secret-name`. For example: MyRelease-MySecret + +This allows the secrets to be affiliated with the release, but not directly included with the release. +Use below command to create a secret: +``` +kubectl create secret generic my-release- \ + --from-literal='api-user=XXXX' \ + --from-literal='controller-key=XXXX' \ + --from-literal='event-key=XXXX' \ + --namespace namespace_name +``` + +### Image Security Policies + +If the cluster has image security policies enforced, cluster-agent docker images should be added to it. + +``` +apiVersion: securityenforcement.admission.cloud.ibm.com/v1beta1 +kind: ClusterImagePolicy +metadata: +name: ibmcloud-default-cluster-image-policy +spec: + repositories: + - name: docker.io/appdynamics/cluster-agent:* +``` + +### Pod Security Policies +This chart requires container to run as root. +If choosing a non-default namespace, then please select PSP which allows containers to run as root. +Refer [Creating a custom pod security policy](https://www.ibm.com/support/knowledgecenter/SSBS6K_3.1.2/user_management/custom_psp.html) if creating a custom PSP. ## Quick start @@ -35,7 +72,7 @@ helm install appdynamics-charts/cluster-agent --name=stable \ | Parameter | Description | Default | | ------------------------- | ------------------------------------------------------------ | -------------------------- | | `controller.url` | Url of AppDynamics controller | | -| `controller.accountName` | AppDynamics account name | +| `controller.accountName` | AppDynamics account name | | `controller.globalAccountName` | AppDynamics global account name | | | `controller.apiUser` | User account information for API access. See [this doc](https://github.com/Appdynamics/cluster-agent/blob/master/docs/rest-user-role.md) for details | | | `controller.eventKey` | Event API key to publish custom events. Optional | | @@ -57,7 +94,7 @@ helm install appdynamics-charts/cluster-agent --name=stable \ | `deployment.image.tag` | Tag of the machine agent image | `latest` | `deployment.image.pullPolicy` | The machine agent image pull policy| `IfNotPresent` | `deployment.resources ` | Resources directive | See below - +| `existingSecret` | Name of existing secret to use for ClusterAgent application in AppDyanamics | Example resource limits: @@ -66,11 +103,12 @@ Example resource limits: limits: cpu: 200m memory: "300M" - requests: + requests: cpu: 100m memory: "100M" ``` +## Limitation +A fully functional AppDyanmics account is needed to install this chart. Lite Appdyanamics account is not currently supported. - - - +## Support +AppDynamics has a wide variety of community and commercial support options available for users. Visit [AppDynamics Support Page](https://www.appdynamics.com/support/) for details. diff --git a/cluster-agent/templates/NOTES.txt b/cluster-agent/templates/NOTES.txt index 44c1a3d..5ffa713 100644 --- a/cluster-agent/templates/NOTES.txt +++ b/cluster-agent/templates/NOTES.txt @@ -1,4 +1,4 @@ -{{- if and .Values.controller.apiUser .Values.controller.url }} +{{- if and .Values.controller.url ( or .Values.controller.apiUser .Values.existingSecret) }} AppDynamics ClusterAgent is deployed successfully. To get more information about the release, try these commands: diff --git a/cluster-agent/templates/_helpers.tpl b/cluster-agent/templates/_helpers.tpl index cc1a7c6..6dd53c5 100644 --- a/cluster-agent/templates/_helpers.tpl +++ b/cluster-agent/templates/_helpers.tpl @@ -30,3 +30,14 @@ Create chart name and version as used by the chart label. {{- define "cluster-agent.chart" -}} {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} {{- end -}} + +{{/* +Get the password secret. +*/}} +{{- define "cluster-agent.secretName" -}} +{{- if .Values.existingSecret -}} + {{- printf "%s" .Values.existingSecret -}} +{{- else -}} + {{- printf "%s" (include "cluster-agent.fullname" .) -}} +{{- end -}} +{{- end -}} diff --git a/cluster-agent/templates/agent-config.yaml b/cluster-agent/templates/agent-config.yaml index 06b0111..9fc514d 100644 --- a/cluster-agent/templates/agent-config.yaml +++ b/cluster-agent/templates/agent-config.yaml @@ -79,3 +79,9 @@ kind: ConfigMap metadata: name: cluster-agent-config namespace: {{ .Release.Namespace }} + labels: + app.kubernetes.io/name: {{ include "cluster-agent.name" . }} + helm.sh/chart: {{ include "cluster-agent.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} + release: {{ .Release.Name }} diff --git a/cluster-agent/templates/deployment.yaml b/cluster-agent/templates/deployment.yaml index dbb7fc2..e303782 100644 --- a/cluster-agent/templates/deployment.yaml +++ b/cluster-agent/templates/deployment.yaml @@ -1,63 +1,75 @@ -apiVersion: extensions/v1beta1 +apiVersion: apps/v1 kind: Deployment -metadata: +metadata: name: {{ template "cluster-agent.fullname" . }} -spec: + labels: + app.kubernetes.io/name: {{ include "cluster-agent.name" . }} + helm.sh/chart: {{ include "cluster-agent.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} + release: {{ .Release.Name }} +spec: replicas: 1 - template: - metadata: - annotations: + selector: + matchLabels: + app.kubernetes.io/name: {{ include "cluster-agent.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} + release: {{ .Release.Name }} + template: + metadata: + annotations: appd-agent-id: appdynamics-cluster-agent labels: - app: {{ template "cluster-agent.name" . }} - chart: {{ template "cluster-agent.chart" . }} + app.kubernetes.io/name: {{ include "cluster-agent.name" . }} + helm.sh/chart: {{ include "cluster-agent.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} release: {{ .Release.Name }} - heritage: {{ .Release.Service }} - restartPolicy: Always - spec: - containers: - - env: + spec: + restartPolicy: Always + containers: + - env: {{- if .Values.controller.controllerKey }} - name: APPDYNAMICS_AGENT_ACCOUNT_ACCESS_KEY - valueFrom: - secretKeyRef: + valueFrom: + secretKeyRef: key: controller-key - name: cluster-agent-secret + name: {{ template "cluster-agent.secretName" . }} {{- end }} {{- if .Values.controller.eventKey }} - name: APPDYNAMICS_EVENT_ACCESS_KEY - valueFrom: - secretKeyRef: + valueFrom: + secretKeyRef: key: event-key - name: cluster-agent-secret + name: {{ template "cluster-agent.secretName" . }} {{- end }} - name: APPDYNAMICS_REST_API_CREDENTIALS - valueFrom: - secretKeyRef: + valueFrom: + secretKeyRef: key: api-user - name: cluster-agent-secret + name: {{ template "cluster-agent.secretName" . }} - name: APPDYNAMICS_AGENT_NAMESPACE - valueFrom: - fieldRef: + valueFrom: + fieldRef: fieldPath: metadata.namespace image: "{{ .Values.deployment.image.repository }}:{{ .Values.deployment.image.tag }}" imagePullPolicy: {{ .Values.deployment.image.pullPolicy }} name: {{ .Chart.Name }} - ports: + ports: - containerPort: {{ .Values.deployment.port }} protocol: TCP resources: {{- if .Values.deployment.resources }} -{{ toYaml .Values.deployment.resources | indent 10 }} +{{ toYaml .Values.deployment.resources | indent 12 }} {{- else if .Values.resources }} -{{ toYaml .Values.resources | indent 10 }} +{{ toYaml .Values.resources | indent 12 }} {{- end }} - volumeMounts: + volumeMounts: - mountPath: /opt/appdynamics/config/ name: agent-config serviceAccountName: appdynamics-operator - volumes: - - configMap: + volumes: + - configMap: name: cluster-agent-config name: agent-config - diff --git a/cluster-agent/templates/rbac.yaml b/cluster-agent/templates/rbac.yaml index bd5136f..01750c4 100644 --- a/cluster-agent/templates/rbac.yaml +++ b/cluster-agent/templates/rbac.yaml @@ -3,13 +3,24 @@ apiVersion: v1 kind: ServiceAccount metadata: name: {{ .Values.serviceAccount.name }} -namespace: {{ .Release.Namespace }} + labels: + app.kubernetes.io/name: {{ include "cluster-agent.name" . }} + helm.sh/chart: {{ include "cluster-agent.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} + release: {{ .Release.Name }} --- apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: creationTimestamp: null name: {{ .Values.serviceAccount.name }} + labels: + app.kubernetes.io/name: {{ include "cluster-agent.name" . }} + helm.sh/chart: {{ include "cluster-agent.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} + release: {{ .Release.Name }} rules: - apiGroups: - "" @@ -49,12 +60,12 @@ rules: - statefulsets verbs: - '*' -- apiGroups: +- apiGroups: - "batch" - "extensions" - resources: + resources: - "jobs" - verbs: + verbs: - "get" - "list" - "watch" @@ -86,6 +97,12 @@ kind: ClusterRoleBinding apiVersion: rbac.authorization.k8s.io/v1 metadata: name: {{ .Values.serviceAccount.name }} + labels: + app.kubernetes.io/name: {{ include "cluster-agent.name" . }} + helm.sh/chart: {{ include "cluster-agent.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} + release: {{ .Release.Name }} subjects: - kind: ServiceAccount name: {{ .Values.serviceAccount.name }} diff --git a/cluster-agent/templates/secret.yaml b/cluster-agent/templates/secret.yaml index 73942e2..5b575b5 100644 --- a/cluster-agent/templates/secret.yaml +++ b/cluster-agent/templates/secret.yaml @@ -1,13 +1,14 @@ -{{- if .Values.controller.apiUser }} +{{- if and (.Values.controller.apiUser) (not .Values.existingSecret) }} apiVersion: v1 kind: Secret metadata: - name: cluster-agent-secret + name: {{ template "cluster-agent.fullname" . }} labels: - app: {{ template "cluster-agent.name" . }} - chart: {{ template "cluster-agent.chart" . }} + app.kubernetes.io/name: {{ include "cluster-agent.name" . }} + helm.sh/chart: {{ include "cluster-agent.name" . }} + app.kubernetes.io/instance: {{ .Release.Name }} + app.kubernetes.io/managed-by: {{ .Release.Service }} release: {{ .Release.Name }} - heritage: {{ .Release.Service }} type: Opaque data: api-user: {{ .Values.controller.apiUser | b64enc | quote }} diff --git a/cluster-agent/templates/service.yaml b/cluster-agent/templates/service.yaml index 755891e..eccbf72 100644 --- a/cluster-agent/templates/service.yaml +++ b/cluster-agent/templates/service.yaml @@ -4,9 +4,10 @@ metadata: name: {{ include "cluster-agent.fullname" . }} labels: app.kubernetes.io/name: {{ include "cluster-agent.name" . }} - helm.sh/chart: {{ include "cluster-agent.chart" . }} + helm.sh/chart: {{ include "cluster-agent.name" . }} app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/managed-by: {{ .Release.Service }} + release: {{ .Release.Name }} spec: ports: - port: {{ .Values.agent.agentServerPort }} @@ -15,4 +16,4 @@ spec: name: http selector: app.kubernetes.io/name: {{ include "cluster-agent.name" . }} - app.kubernetes.io/instance: {{ .Release.Name }} \ No newline at end of file + app.kubernetes.io/instance: {{ .Release.Name }} diff --git a/cluster-agent/values.yaml b/cluster-agent/values.yaml index 84a56b1..345223a 100644 --- a/cluster-agent/values.yaml +++ b/cluster-agent/values.yaml @@ -3,15 +3,23 @@ deployment: image: repository: docker.io/appdynamics/cluster-agent tag: latest - pullPolicy: IfNotPresent + pullPolicy: Always resources: limits: cpu: 200m memory: "300M" - requests: + requests: cpu: 100m memory: "100M" +resources: + limits: + cpu: + memory: + requests: + cpu: + memory: + controller: url: null accountName: "" @@ -23,8 +31,6 @@ controller: analytics: eventEndpoint: "" - - agent: appName: "K8s-Cluster-Agent" tierName: "ClusterAgent" @@ -34,11 +40,8 @@ agent: snapshotSyncInterval: 15 agentServerPort: 8989 - - serviceAccount: create: true name: appdynamics-operator -metrics-server: - install: true +existingSecret: