|
| 1 | +--- |
| 2 | +title: "Services Only Applications" |
| 3 | +linkTitle: "Services Only Applications" |
| 4 | +weight: 50 |
| 5 | +type: "docs" |
| 6 | +tags: ["services Only", "tenant independent"] |
| 7 | +description: > |
| 8 | + Deploying CAP applications with only service workloads (tenant-independent). |
| 9 | +--- |
| 10 | + |
| 11 | +This guide explains how to deploy a CAP application containing only service workloads (those that are tenant-independent). |
| 12 | + |
| 13 | +## Deploying Services Only Applications |
| 14 | + |
| 15 | +Services only applications don't require tenant-specific configurations. Therefore, the `provider` section is omitted from the `CAPApplication` resource, and the `CAPApplicationVersion` should only define deployments of type `Service`, alongside optional `Content` jobs. |
| 16 | + |
| 17 | +Because these applications are tenant-independent, no tenant related resources are created. |
| 18 | + |
| 19 | +The service workloads may be exposed externally via `serviceExposures` configuration on the [version](#version-configuration-capapplicationversion). |
| 20 | + |
| 21 | +### Application Configuration (`CAPApplication`) |
| 22 | + |
| 23 | +Create a `CAPApplication` resource without a `provider` section, as shown below: |
| 24 | + |
| 25 | +```yaml |
| 26 | +apiVersion: sme.sap.com/v1alpha1 |
| 27 | +kind: CAPApplication |
| 28 | +metadata: |
| 29 | + name: test-ca-01 |
| 30 | + namespace: default |
| 31 | +spec: |
| 32 | + btp: |
| 33 | + services: |
| 34 | + - class: xsuaa |
| 35 | + name: cap-uaa |
| 36 | + secret: cap-cap-01-uaa-bind-cf |
| 37 | + - class: xsuaa |
| 38 | + name: cap-uaa2 |
| 39 | + secret: cap-cap-01-uaa2-bind-cf |
| 40 | + - class: service-manager |
| 41 | + name: cap-service-manager |
| 42 | + secret: cap-cap-01-svc-man-bind-cf |
| 43 | + btpAppName: test-cap-01 |
| 44 | + domains: |
| 45 | + istioIngressGatewayLabels: |
| 46 | + - name: app |
| 47 | + value: istio-ingressgateway |
| 48 | + - name: istio |
| 49 | + value: ingressgateway |
| 50 | + primary: app-domain.test.local |
| 51 | + secondary: |
| 52 | + - foo.bar.local |
| 53 | + globalAccountId: btp-glo-acc-id |
| 54 | +``` |
| 55 | +
|
| 56 | +### Version Configuration (`CAPApplicationVersion`) |
| 57 | + |
| 58 | +Create a `CAPApplicationVersion` in the same namespace as the `CAPApplication` with service workloads and any content jobs. The `serviceExposures` section defines how the service is exposed externally, for example, via Istio `VirtualService` resources. |
| 59 | + |
| 60 | +```yaml |
| 61 | +apiVersion: sme.sap.com/v1alpha1 |
| 62 | +kind: CAPApplicationVersion |
| 63 | +metadata: |
| 64 | + name: cav-ca-app-01-1 |
| 65 | + namespace: default # Same namespace as CAPApplication |
| 66 | +spec: |
| 67 | + capApplicationInstance: test-ca-01 # Reference to the CAPApplication |
| 68 | + version: "0.0.1" |
| 69 | + registrySecrets: |
| 70 | + - regcred |
| 71 | + workloads: |
| 72 | + - name: cap-backend-service |
| 73 | + consumedBTPServices: # Services used by this workload |
| 74 | + - app-uaa |
| 75 | + - app-service-manager |
| 76 | + - app-saas-registry |
| 77 | + deploymentDefinition: |
| 78 | + type: Service # Defines this as a service workload |
| 79 | + image: app.some.repo.example.com/srv/server:0.0.1 |
| 80 | + env: |
| 81 | + - name: CDS_ENV |
| 82 | + value: production |
| 83 | + ports: |
| 84 | + - name: server |
| 85 | + port: 4004 |
| 86 | + appProtocol: http |
| 87 | + - name: api |
| 88 | + port: 8000 |
| 89 | + appProtocol: http |
| 90 | + - name: metrics |
| 91 | + port: 4005 |
| 92 | + appProtocol: http |
| 93 | + - name: service-content # Example content job |
| 94 | + consumedBTPServices: |
| 95 | + - app-uaa |
| 96 | + - app-html5-repo-host |
| 97 | + - app-portal |
| 98 | + jobDefinition: |
| 99 | + type: Content |
| 100 | + image: app.some.repo.example.com/approuter/content:0.0.1 |
| 101 | + backoffLimit: 1 |
| 102 | + serviceExposures: |
| 103 | + - subDomain: service |
| 104 | + routes: |
| 105 | + - workloadName: cap-backend-service |
| 106 | + port: 4004 |
| 107 | + - subDomain: api |
| 108 | + routes: |
| 109 | + - workloadName: cap-backend-service |
| 110 | + port: 8000 |
| 111 | + path: /api |
| 112 | +``` |
| 113 | + |
| 114 | +### Important Considerations |
| 115 | + |
| 116 | +* The `CAPApplication` reaches a `Consistent` state, only after |
| 117 | + - the latest `CAPApplicationVersion` is Ready. |
| 118 | + - the creation of Istio `VirtualService`, which allows HTTP requests on the `serviceExposure` subdomain to reach the application. |
| 119 | +* The `CAPApplication` status for services only applications will have a `servicesOnly` field set to `true`. |
| 120 | +* There is no `CAPTenant` or other tenant related resources created for such services only scenario. Any tenant-related logic within the service itself is the responsibility of the consuming application. |
| 121 | +* You cannot switch a `CAPApplicationVersion` between services only and tenant-dependent modes after initial creation of overall application. Choose the appropriate mode from the start. |
| 122 | +* A successful upgrade of the `CAPApplicationVersion` will cause any service related `VirtualService` resources to be modified to route HTTP traffic to the deployments of the newer `CAPApplicationVersion`. Once a new `CAPApplicationVersion` is `Ready` and the service only application is automatically upgraded, the outdated `CAPApplicationVersion` can be deleted. |
0 commit comments