Struct controller::app_service::types::AppService

pub struct AppService {
    pub name: String,
    pub image: String,
    pub args: Option<Vec<String>>,
    pub command: Option<Vec<String>>,
    pub env: Option<Vec<EnvVar>>,
    pub resources: ResourceRequirements,
    pub probes: Option<Probes>,
    pub middlewares: Option<Vec<Middleware>>,
    pub routing: Option<Vec<Routing>>,
    pub storage: Option<StorageConfig>,
}

AppService significantly extends the functionality of your Tembo Postgres instance by running tools and software built by the Postgres open source community.

Example: This will configure and install a Postgrest container along side the Postgres instance, install pg_graphql extension, and configure the ingress routing to expose the Postgrest service.

apiVersion: coredb.io/v1alpha1
kind: CoreDB
metadata:
  name: test-db
spec:
  trunk_installs:
    - name: pg_graphql
      version: 1.2.0
  extensions:
    - name: pg_graphql
      locations:
      - database: postgres
        enabled: true
  
  appServices:
    - name: postgrest
      image: postgrest/postgrest:v10.0.0
      routing:
      # only expose /rest/v1 and /graphql/v1
        - port: 3000
          ingressPath: /rest/v1
          middlewares:
            - my-headers
        - port: 3000
          ingressPath: /graphql/v1
          middlewares:
            - map-gql
            - my-headers
      middlewares:
        - customRequestHeaders:
          name: my-headers
          config:
            # removes auth header from request
            Authorization: ""
            Content-Profile: graphql
            Accept-Profile: graphql
        - stripPrefix:
          name: my-strip-prefix
          config:
            - /rest/v1
        # reroute gql and rest requests
        - replacePathRegex:
          name: map-gql
          config:
            regex: \/graphql\/v1\/?
            replacement: /rpc/resolve
      env:
        - name: PGRST_DB_URI
          valueFromPlatform: ReadWriteConnection
        - name: PGRST_DB_SCHEMA
          value: "public, graphql"
        - name: PGRST_DB_ANON_ROLE
          value: postgres
        - name: PGRST_LOG_LEVEL
          value: info

Fields

name: String

Defines the name of the appService.

image: String

Defines the container image to use for the appService.

args: Option<Vec<String>>

Defines the arguments to pass into the container if needed. You define this in the same manner as you would for all Kubernetes containers. See the Kubernetes docs.

command: Option<Vec<String>>

Defines the command into the container if needed. You define this in the same manner as you would for all Kubernetes containers. See the Kubernetes docs.

env: Option<Vec<EnvVar>>

Defines the environment variables to pass into the container if needed. You define this in the same manner as you would for all Kubernetes containers. See the Kubernetes docs.

resources: ResourceRequirements

Defines the resources to allocate to the container. You define this in the same manner as you would for all Kubernetes containers. See the Kubernetes docs.

probes: Option<Probes>

Defines the probes to use for the container. You define this in the same manner as you would for all Kubernetes containers. See the Kubernetes docs.

middlewares: Option<Vec<Middleware>>

Defines the ingress middeware configuration for the appService. This is specifically configured for the ingress controller Traefik.

routing: Option<Vec<Routing>>

Defines the routing configuration for the appService.

storage: Option<StorageConfig>

Defines the storage configuration for the appService.

Trait Implementations

impl Clone for AppService

fn clone(&self) -> AppService

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AppService

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for AppService

fn default() -> AppService

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AppService

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for AppService

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for AppService

fn eq(&self, other: &AppService) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AppService

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for AppService

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl StructuralPartialEq for AppService