Skip to content

Latest commit

 

History

History
135 lines (105 loc) · 4.61 KB

README-old.md

File metadata and controls

135 lines (105 loc) · 4.61 KB
Raw

REUSE status

CFAPI Kyma Module

Overview

CF API Kyma Module is providing a CF API to run on top of Kyma, using the open source Korifi project Once installed, one could use the cf cli to connect and deploy workloads.

Custom Resource (CR) Specification

Property Optional Default Description
RootNamespace Optional cf Root namespace for CF resources
AppImagePullSecret Optional By default a localregistry will be deployed and used for application images Dockerregistry secret pointing to a custom docker registry
UAA Optional "https://uaa.cf.eu10.hana.ondemand.com" UAA URL to be used for authentication
CFAdmins Optional By default Kyma cluster-admins will become CF admins List of users, which will become CF administrators.A user is expected in format sap.ids:<sap email> example sap.ids:[email protected]

Prerequisites

  • A Kyma cluster preconfigured with UAA as OIDC provider
  • Istio Kyma module installed
  • [Maybe] Docker registry kyma module installed

Installation

  1. Kyma environment

    You need a Kyma environment which is configured with UAA as an OIDC provider, with following parameters

{
  "administrators": [
    "sap.ids:[email protected]"
  ],
  "autoScalerMax": 3,
  "autoScalerMin": 3,
  "oidc": {
    "clientID": "cf",
    "groupsClaim": "",
    "issuerURL": "https://uaa.cf.eu10.hana.ondemand.com/oauth/token",
    "signingAlgs": [
      "RS256"
    ],
    "usernameClaim": "user_name",
    "usernamePrefix": "sap.ids:"
  }
}

  1. Kyma Access

At the moment there is a problem that with OIDC provider set to UAA, the kubeconfig for Kyma is not working. This is well-known, solution is expected to come. Here is how you could generate a working kubeconfig.

2.1. Download your kubeconfig from BTP cockpit/kyma environment

2.2. Create a folder and copy that kubeconfig there, file name kubeconfig.yaml. Take the full path of that file
Example Linux: /tmp/genkubeconfig
Example Windows: C:\tmp\genkubeconfig

2.3. Run the command, use your user name [email protected] as an argument

docker run -v /tmp/genkubeconfig:/work -ti ghcr.io/kyma-project/cfapi/genkubeconfig [email protected]
or
docker run -v C:\tmp\genkubeconfig:/work -ti ghcr.io/kyma-project/cfapi/genkubeconfig [email protected]

2.4. The generated kubeconfig is in /tmp/genkubeconfig/kubeconfig-sa.yaml,

2.5. [Maybe] Set it as system kubeconfing ~/.kube/config. That step is optional, depends on your system setup

cp /tmp/genkubeconfig/kubeconfig-sa.yaml ~/.kube/config

  1. Istio installed

    If Istio Kyma module is not installed, you can do it with:

make from this repository

make install-istio

Or directly with kubectl

kubectl label namespace cfapi-system istio-injection=enabled --overwrite
kubectl apply -f https://github.com/kyma-project/istio/releases/latest/download/istio-manager.yaml
kubectl apply -f https://github.com/kyma-project/istio/releases/latest/download/istio-default-cr.yaml

  1. [Maybe] deploy docker registry module

In case you want to use an existing docker registry, you do not need to install that. In all other cases, see https://github.com/kyma-project/docker-registry/blob/main/docs/user/README.md

kubectl apply -f https://github.com/kyma-project/docker-registry/releases/latest/download/dockerregistry-operator.yaml

  1. Deploy CF API

Deploy the resources from a particular release /in the example below 0.0.6/ version to kyma

kubectl create namespace cfapi-system
kubectl apply -f https://github.com/kyma-project/cfapi/releases/download/0.0.6/cfapi-manager.yaml
kubectl apply -f https://github.com/kyma-project/cfapi/releases/download/0.0.6/cfapi-default-cr.yaml

Wait for a Ready state of the CFAPI resource and read the CF URL

kubectl get -n cfapi-system cfapi
NAME             STATE   URL
default-cf-api   Ready   https://cfapi.cc6e362.kyma.ondemand.com

  1. Configure CF cli

    Set cf cli to point to CF API

cf api https://cfapi.cc6e362.kyma.ondemand.com

  1. CF Login

cf login --sso

Usage

Use CF cli to deploy applications as on a normal CF. The buildpacks used are native community buildpacks.

Development

Contributing

See the Contributing Rules.

Code of Conduct

See the Code of Conduct document.

Licensing

See the license file.