Skip to content

Latest commit

 

History

History
95 lines (66 loc) · 5.25 KB

README.md

File metadata and controls

95 lines (66 loc) · 5.25 KB
Raw

PostgreSQL Connector Sample App - NpgsqlConnection

ASP.NET Core sample app illustrating how to use Steeltoe PostgreSQL Connector for connecting to a PostgreSQL service on CloudFoundry. This sample illustrates using a NpgsqlConnection to issue commands to the bound database. There is also an additional sample that illustrates how to use Entity Framework Core.

General prerequisites

  1. Installed .NET Core SDK

Running locally

  1. Started PostgreSQL docker container

Running on CloudFoundry

  1. Installed CloudFoundry (optionally with Windows support)
  2. Installed VMware Tanzu Cloud Service Broker

Create PostgreSQL Service Instance on CloudFoundry

You must first create an instance of the PostgreSQL service in an org/space.

  1. cf target -o your-org -s your-space
  2. cf create-service csb-azure-postgresql small myPostgreSqlService or cf create-service csb-google-postgres default myPostgreSqlService

Publish App & Push to CloudFoundry

  1. cf target -o your-org -s your-space
  2. cd samples/Connectors/src/PostgreSql
  3. Push the app
    • When using Windows containers:
      • Publish app to a local directory, specifying the runtime:
        • dotnet restore --configfile nuget.config
        • dotnet publish -r win-x64 --self-contained
      • Push the app using the appropriate manifest:
        • cf push -f manifest-windows.yml -p bin/Debug/net6.0/win-x64/publish
    • Otherwise:
      • Push the app using the appropriate manifest:
        • cf push -f manifest.yml

Note: The provided manifest(s) will create an app named postgresql-connector and attempt to bind the app to PostgreSQL service myPostgreSqlService.

What to expect - CloudFoundry

To see the logs as you startup and use the app: cf logs postgresql-connector

On a Windows cell, you should see something like this during startup:

2016-08-05T07:23:02.15-0600 [CELL/0]     OUT Creating container
2016-08-05T07:23:03.81-0600 [CELL/0]     OUT Successfully created container
2016-08-05T07:23:09.07-0600 [APP/0]      OUT Running .\PostgreSql
2016-08-05T07:23:14.68-0600 [APP/0]      OUT Hosting environment: development
2016-08-05T07:23:14.68-0600 [APP/0]      OUT Content root path: C:\containerizer\75E10B9301D2D9B4A8\user\app
2016-08-05T07:23:14.68-0600 [APP/0]      OUT Application started. Press Ctrl+C to shut down.
2016-08-05T07:23:14.68-0600 [APP/0]      OUT Now listening on: http://*:51217

This sample will be available at http://postgresql-connector.[your-cf-apps-domain]/.

Upon startup, the app inserts a couple of rows into the bound PostgreSQL database. They are displayed on the home page.

Running on Tanzu Application Platform (TAP)

Pre-requisites:

  1. Kubernetes with Tanzu Application Platform installed
  2. Postgres services are set up for consumption by developers

Create PostgreSQL Service Instance/Binding on TAP

Yaml files for creating the needed resources are included with this project, and their usage is specified below, but you are encouraged to review and/or customize the contents of the files before applying them.

  1. Create a Postgres Service Instance
    • For complete instructions, follow the documentation
    • For a simplified experience, use the yaml included with this project: kubectl apply -f ./config/service-operator/postgres.yaml
  2. Create a Postgres Service Binding/Claim
    • For complete instructions, follow the documentation
    • For a simplified experience, use the yaml included with this project: kubectl apply -f ./config/app-operator/postgres-resource-claim.yaml
    • Optional: specify a resource claim policy (for using resources across namespaces): kubectl apply -f ./config/app-operator/postgres-resource-claim-policy.yaml

Publish App & Push to TAP

  1. cd samples/Connectors/src/PostgreSql
  2. Optional: If you created your service or bindings without using the included yaml, modify the serviceClaims section of the included workload.yaml with claim details to match what you created.
  3. Publish app to a local directory, specifying the runtime:
    • dotnet restore --configfile nuget.config
    • dotnet publish -r linux-x64 --no-self-contained
  4. Push the app to TAP:
    • tanzu app workload apply --local-path ./bin/Debug/net6.0/linux-x64/publish --source-image <registry-reference> -f ./config/workload.yaml -y
    • See the Tanzu Apps CLI documentation for details.

See the Official Steeltoe Service Connectors Documentation for a more in-depth walkthrough of the samples and more detailed information