Skip to content

Commit

Permalink
Merge pull request #198 from citrix/docs
Browse files Browse the repository at this point in the history 
Docs
  • Loading branch information
@sreejithgs
sreejithgs committed Feb 17, 2020
2 parents 8a2cfbd + 6de8672 commit 36e13b5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 9 deletions.
16 changes: 9 additions & 7 deletions docs/canary/canary.md
View file
Expand Up @@ -237,7 +237,7 @@ Perform the following steps to deploy a sample application as a canary release.
kubectl apply -f exporter.yaml

!!! note "Note"
Depending on how you are deploying the Citrix ingress controller, you need to edit the YAML file for Citrix ingress controller deployment and modify values for the environmental variables as provided in [deploying Citrix ingress controller](https://developer-docs.citrix.com/projects/citrix-k8s-ingress-controller/en/latest/deploy/deploy-cic-yaml/#deploy-citrix-ingress-controller-as-a-pod).
Depending on how you are deploying the Citrix ingress controller, you must edit the YAML file for Citrix ingress controller deployment and modify values for the environmental variables as provided in [deploying Citrix ingress controller](https://developer-docs.citrix.com/projects/citrix-k8s-ingress-controller/en/latest/deploy/deploy-cic-yaml/#deploy-citrix-ingress-controller-as-a-pod).

1. Deploy the Ingress for securely exposing Spinnaker using the [spin-ingress-ssl.yaml](https://github.com/citrix/citrix-k8s-ingress-controller/blob/master/canary/manifest/spin-ingress-ssl.yaml) file.

Expand Down Expand Up @@ -278,18 +278,20 @@ Perform the following steps to deploy a sample application as a canary release.

| Field | Description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| serviceName | List of services on which this CRD has to be applied |
| serviceNames | List of services on which this CRD has to be applied |
| deployment | Specifies the deployment strategy as Kayenta. |
| percentage | Specifies the percentage of traffic to be diverted from production to baseline and canary. |
| newImageTag (optional) | Specifies the label(key, value pair) to be searched in deployment for checking if it is a canary deployment. If the name of the canary deployment has the string "canary", it would be taken as a canary deployment by default. |
| productionImageTag (optional) | Specifies the label (key, value pair) to be searched in deployment for checking if it is a baseline deployment. If the name of the deployment has the string "baseline", it would be taken as a baseline deployment by default. |
| percentage | Specifies the percentage of traffic to be diverted from production to baseline and canary. |
| matchExpression (optional) | Any Citrix ADC supported policy that can be used to define the subset of users to be directed to canary and baseline versions. If x percentage of traffic is configured, then from within subset of users which matches the matchExpression only x percentage of users are diverted to baseline and canary. Remaining users are diverted to production. |
| domain | IP address or domain name of the Spinnaker gate. |
| Spinnaker | Specifies the Spinnaker pipeline configurations you want to apply for your services. |
| domain | IP address or domain name of the Spinnaker gate. |
| port | Port number of the Spinnaker gate. |
| applicationName | The name of the application in Spinnaker. |
| pipelineName | The name of the pipeline under the Spinnaker application. |
| serviceName| Specifies the name of the service to which you want to apply the Spinnaker configuration.|

1. Deploy canary and baseline versions of the application.

10. Deploy canary and baseline versions of the application.

!!! note "Note"
If you are fully automating the canary deployment, deploy canary and baseline versions using the [Deploy (Manifest) stage](https://www.spinnaker.io/guides/user/kubernetes-v2/deploy-manifest/) in Spinnaker pipeline and there is no need to perform this step.
Expand Down
4 changes: 2 additions & 2 deletions docs/configure/annotations.md
View file
Expand Up @@ -45,7 +45,7 @@ metadata:
annotations:
ingress.citrix.com/insecure-port: "80"
ingress.citrix.com/frontend-ip: "192.168.1.1"
ingress.citrix.com/lbvserver: '{"citrix-svc":{"lbmethod":"LEASTCONNECTION", “persistenceType":"SOURCEIP"}}'
ingress.citrix.com/lbvserver: '{"citrix-svc":{"lbmethod":"LEASTCONNECTION", "persistenceType":"SOURCEIP"}}'
ingress.citrix.com/servicegroup: '{"citrix-svc":{"usip":"yes"}}'
ingress.citrix.com/monitor: '{"citrix-svc":{"type":"http"}}'
spec:
Expand All @@ -63,6 +63,6 @@ The sample Ingress YAML includes use cases related to the service, `citrix-svc`,

| Smart Annotation | Description |
| ---------------- | ----------- |
| `ingress.citrix.com/lbvserver: '{"citrix-svc":{"lbmethod":"LEASTCONNECTION", “persistenceType":"SOURCEIP"}}'` | Sets the load balancing method as [Least Connection](https://docs.citrix.com/en-us/citrix-adc/12-1/load-balancing/load-balancing-customizing-algorithms/leastconnection-method.html) and also configures [Source IP address persistence](https://docs.citrix.com/en-us/citrix-adc/12-1/load-balancing/load-balancing-persistence/source-ip-persistence.html). |
| `ingress.citrix.com/lbvserver: '{"citrix-svc":{"lbmethod":"LEASTCONNECTION", "persistenceType":"SOURCEIP"}}'` | Sets the load balancing method as [Least Connection](https://docs.citrix.com/en-us/citrix-adc/12-1/load-balancing/load-balancing-customizing-algorithms/leastconnection-method.html) and also configures [Source IP address persistence](https://docs.citrix.com/en-us/citrix-adc/12-1/load-balancing/load-balancing-persistence/source-ip-persistence.html). |
| `ingress.citrix.com/servicegroup: '{"citrix-svc":{"usip":"yes"}}'` | Enables [Use Source IP Mode (USIP)](https://docs.citrix.com/en-us/citrix-adc/12-1/networking/ip-addressing/enabling-use-source-ip-mode.html) on the Ingress Citrix ADC device. When you enable USIP on the Citrix ADC, it uses the client's IP address for communication with the back-end pods. |
| `ingress.citrix.com/monitor: '{"citrix-svc":{"type":"http"}}'` | Creates a [custom HTTP monitor](https://docs.citrix.com/en-us/citrix-adc/12-1/load-balancing/load-balancing-custom-monitors.html) for the servicegroup. |

0 comments on commit 36e13b5

Please sign in to comment.