deploy a FIWARE context broker on OpenShift Local and WasteWaterPlant Smart Model Data apps #282
Description
deploy a FIWARE context broker on OpenShift Local and WasteWaterPlant Smart Model Data apps
Your mission, should you choose to accept it, is to deploy a FIWARE context broker on OpenShift Local and WasteWaterPlant Smart Model Data apps.
Walk through Youtube videos related to your task
These Youtube videos have been carefully prepared to help you with this data import task:
- Installing OpenShift Local for doing cloud computing on your personal computer!
- Install a Hashicorp Vault on OpenShift Local to easily secure your GitOps
- Configure Vault token, policy, auth method, role, and secret to secure your GitOps
- Install ArgoCD on Openshift Local to monitor the state of your GitOps and Applications
- Setup External Secret linked to Vault in OpenShift Local to keep your application passwords secure
- Deploy ArgoCD Apps to OpenShift Local like MongoDB and the Orion LD Context Broker
More details about your task
- Deploy the Orion LD Context Broker provided by FIWARE using these instructions.
- Help your other team members who also wish to deploy the Orion LD Context Broker on their own OpenShift Local environment.
- Work with your data specialist to import your WasteWaterPlant data into the FIWARE Context Broker running in your OpenShift Local environment.
- Work with your visualization specialist to deploy visualization tools to your OpenShift Local environment.
- Work with your documentation specialist to document the deployment of the OpenShift Local environment, the WasteWaterPlant data, and the visualization tools.
- If you are not sure what kind of applications you could deploy to gather WasteWaterPlant data, you may want to use your imagination. Imagine if there was a WasteWaterPlant sensor in your actual city, or a WasteWaterPlant sensor in a small scale toy city that you could simulate. What kind of sensors could you use? How would you design such a simulation in an actual city or a toy city? How would you visualize WasteWaterPlant data in an actual city or a toy city?
- To the
orion-ldDeployment in thefiwarenamespace, I suggest adding an Environment VariableORIONLD_CORS_ALLOWED_ORIGINto__ALLso that the visualization specialist's application will be able to make requests to the Context Broker using JavaScript and AJAX.
The day of the operation is Thursday February 2nd, 2023
You will have 4 hours to complete your mission.
Work with Smart Data Models and the FIWARE Context broker in Europe
At the end of the day
Should you, or any of your force be taken or compromised that day, you must report back as many changes as you have made, and any knowledge of your actions, by pull request or comments on the issue on the board.
The details of your mission:
Entity: WasteWaterPlant
document generated automatically
Global description: Data model for waste water treatment plant.
List of properties
address: The mailing addressalternateName: An alternative name for this itemareaServed: The geographic area where a service or offered item is providedbod: Biological Oxygen Demand concentration measured in the waste-water treatment plant corresponding to this observation.cod: Chemical Oxygen Demand concentration measured in the waste-water treatment plant corresponding to this observation.dataProvider: A sequence of characters identifying the provider of the harmonised data entity.dateCreated: Entity creation timestamp. This will usually be allocated by the storage platform.dateModified: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform.description: A description of this itemdo: Dissolved oxygen measured in the waste-water treatment plant corresponding to this observation.id: Unique identifier of the entityinFlow: In-flow amount into the treatment plant/reservoir corresponding to this observation.location: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygonmunicipalityInfo: Municipality information corresponding to this observation.name: The name of this item.nh4: Ammonium concentration measured in the waste-water treatment plant corresponding to this observation.no3: Nitrate concentration measured in waste-water treatment plant corresponding to this observation.observationDateTime: Last reported time of observation.outFlow: Out-flow amount into the treatment plant/reservoir corresponding to this observation.owner: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)pHTSA: Acidity level or basicity level observed in the water. Object defining the temporal processing of the magnitude property during a period. It provides maximum, minimum, instant value and averagepo4: Ortho-phosphate concentration measured in the waste-water treatment plant corresponding to this observation.redox: Reduction potential or oxidation measured in waste-water treatment plant corresponding to this observation.seeAlso: list of uri pointing to additional resources about the itemsource: A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object.tic: Total Inorganic Carbon concentration measured in the waste-water treatment plant corresponding to this observation.tn: Total Nitrogen concentration measured in waste-water treatment plant corresponding to this observation.toc: Total Organic Carbon concentration measured in the waste-water treatment plant corresponding to this observation.treatmentPlantCapacity: Handling capacity of the waste-water treatment plant corresponding to this observation.treatmentPlantCode: Unique code for the waste-water treatment plant corresponding to this observation.treatmentPlantId: Unique identification number for the waste-water treatment plant corresponding to this observation.treatmentPlantName: Name of the waste-water treatment plant corresponding to this observation.tss: Total suspended solids concentration measured in a waste-water treatment plant corresponding to this observation.type: NGSI entity type. It has to be WasteWaterPlant
Required properties
idtype
Data Model description of properties
Sorted alphabetically (click for details)
full yaml details
WasteWaterPlant:
description: 'Data model for waste water treatment plant.'
properties:
address:
description: 'The mailing address'
properties:
addressCountry:
description: 'Property. The country. For example, Spain. Model:''https://schema.org/addressCountry'''
type: string
addressLocality:
description: 'Property. The locality in which the street address is, and which is in the region. Model:''https://schema.org/addressLocality'''
type: string
addressRegion:
description: 'Property. The region in which the locality is, and which is in the country. Model:''https://schema.org/addressRegion'''
type: string
postOfficeBoxNumber:
description: 'Property. The post office box number for PO box addresses. For example, 03578. Model:''https://schema.org/postOfficeBoxNumber'''
type: string
postalCode:
description: 'Property. The postal code. For example, 24004. Model:''https://schema.org/https://schema.org/postalCode'''
type: string
streetAddress:
description: 'Property. The street address. Model:''https://schema.org/streetAddress'''
type: string
type: object
x-ngsi:
model: https://schema.org/address
type: Property
alternateName:
description: 'An alternative name for this item'
type: string
x-ngsi:
type: Property
areaServed:
description: 'The geographic area where a service or offered item is provided'
type: string
x-ngsi:
model: https://schema.org/Text
type: Property
bod:
description: 'Biological Oxygen Demand concentration measured in the waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
cod:
description: 'Chemical Oxygen Demand concentration measured in the waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
dataProvider:
description: 'A sequence of characters identifying the provider of the harmonised data entity.'
type: string
x-ngsi:
type: Property
dateCreated:
description: 'Entity creation timestamp. This will usually be allocated by the storage platform.'
format: date-time
type: string
x-ngsi:
type: Property
dateModified:
description: 'Timestamp of the last modification of the entity. This will usually be allocated by the storage platform.'
format: date-time
type: string
x-ngsi:
type: Property
description:
description: 'A description of this item'
type: string
x-ngsi:
type: Property
do:
description: 'Dissolved oxygen measured in the waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
id:
anyOf: &wastewaterplant_-_properties_-_owner_-_items_-_anyof
- description: 'Property. Identifier format of any NGSI entity'
maxLength: 256
minLength: 1
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
type: string
- description: 'Property. Identifier format of any NGSI entity'
format: uri
type: string
description: 'Unique identifier of the entity'
x-ngsi:
type: Property
inFlow:
description: 'In-flow amount into the treatment plant/reservoir corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
location:
description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'
oneOf:
- description: 'Geoproperty. Geojson reference to the item. Point'
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
type: number
minItems: 2
type: array
type:
enum:
- Point
type: string
required:
- type
- coordinates
title: 'GeoJSON Point'
type: object
- description: 'Geoproperty. Geojson reference to the item. LineString'
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type:
enum:
- LineString
type: string
required:
- type
- coordinates
title: 'GeoJSON LineString'
type: object
- description: 'Geoproperty. Geojson reference to the item. Polygon'
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type:
enum:
- Polygon
type: string
required:
- type
- coordinates
title: 'GeoJSON Polygon'
type: object
- description: 'Geoproperty. Geojson reference to the item. MultiPoint'
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
type: number
minItems: 2
type: array
type: array
type:
enum:
- MultiPoint
type: string
required:
- type
- coordinates
title: 'GeoJSON MultiPoint'
type: object
- description: 'Geoproperty. Geojson reference to the item. MultiLineString'
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 2
type: array
type: array
type:
enum:
- MultiLineString
type: string
required:
- type
- coordinates
title: 'GeoJSON MultiLineString'
type: object
- description: 'Geoproperty. Geojson reference to the item. MultiLineString'
properties:
bbox:
items:
type: number
minItems: 4
type: array
coordinates:
items:
items:
items:
items:
type: number
minItems: 2
type: array
minItems: 4
type: array
type: array
type: array
type:
enum:
- MultiPolygon
type: string
required:
- type
- coordinates
title: 'GeoJSON MultiPolygon'
type: object
x-ngsi:
type: Geoproperty
municipalityInfo:
description: 'Municipality information corresponding to this observation.'
properties:
cityId:
description: 'Property. Model:''https://schema.org/Text''. City Id corresponding to this observation.'
type: string
cityName:
description: 'Property. Model:''https://schema.org/Text''. City name corresponding to this observation'
type: string
district:
description: 'Property. Model:''https://schema.org/Text''. District name corresponding to this observation.'
type: string
stateName:
description: 'Property. Model:''https://schema.org/Text''. Name of the state corresponding to this observation.'
type: string
ulbName:
description: 'Property. Model:''https://schema.org/Text''. Name of the Urban Local Body corresponding to this observation.'
type: string
wardId:
description: 'Property. Model:''https://schema.org/Text''. Ward Id corresponding to this observation.'
type: string
wardName:
description: 'Property. Model:''https://schema.org/Text''. Ward name corresponding to this observation.'
type: string
wardNum:
description: 'Property. Model:''https://schema.org/Number''. Ward number corresponding to this observation.'
type: number
zoneId:
description: 'Property. Model:''https://schema.org/Text''. Zone Id corresponding to this observation.'
type: string
zoneName:
description: 'Property. Model:''https://schema.org/Text''. Zone name corresponding to this observation.'
type: string
type: object
x-ngsi:
model: https://schema.org/Text
type: Property
name:
description: 'The name of this item.'
type: string
x-ngsi:
type: Property
nh4:
description: 'Ammonium concentration measured in the waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
no3:
description: 'Nitrate concentration measured in waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
observationDateTime:
description: 'Last reported time of observation.'
format: date-time
type: string
x-ngsi:
model: https://schema.org/Text
type: Property
outFlow:
description: 'Out-flow amount into the treatment plant/reservoir corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
owner:
description: 'A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)'
items:
anyOf: *wastewaterplant_-_properties_-_owner_-_items_-_anyof
description: 'Property. Unique identifier of the entity'
type: array
x-ngsi:
type: Property
pHTSA:
description: 'Acidity level or basicity level observed in the water. Object defining the temporal processing of the magnitude property during a period. It provides maximum, minimum, instant value and average'
properties:
avgOverTime:
description: 'Property. Model:''https://schema.org/Number''. Describes the average value of a time-series data over a specified duration in past. The duration is specified using another parameter in the value descriptor object related to this value'
type: number
instValue:
description: 'Property. Model:''https://schema.org/Number''. Describes the instantaneous value (associated with the current timestamp) of a time varying quantity.'
type: number
maxOverTime:
description: 'Property. Model:''https://schema.org/Number''. Describes the maximum value of a time-series data over a specified duration in past. The duration is specified using another parameter in the value descriptor object related to this value'
type: number
minOverTime:
description: 'Property. Model:''https://schema.org/Number''. Describes the minimum value of a time-series data over a specified duration in past. The duration is specified using another parameter in the value descriptor object related to this value.'
type: number
type: object
x-ngsi:
model: https://schema.org/Text
type: Property
po4:
description: 'Ortho-phosphate concentration measured in the waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
redox:
description: 'Reduction potential or oxidation measured in waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
seeAlso:
description: 'list of uri pointing to additional resources about the item'
oneOf:
- items:
format: uri
type: string
minItems: 1
type: array
- format: uri
type: string
x-ngsi:
type: Property
source:
description: 'A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object.'
type: string
x-ngsi:
type: Property
tic:
description: 'Total Inorganic Carbon concentration measured in the waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
tn:
description: 'Total Nitrogen concentration measured in waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
toc:
description: 'Total Organic Carbon concentration measured in the waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
treatmentPlantCapacity:
description: 'Handling capacity of the waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
treatmentPlantCode:
description: 'Unique code for the waste-water treatment plant corresponding to this observation.'
type: string
x-ngsi:
model: https://schema.org/Text
type: Property
treatmentPlantId:
description: 'Unique identification number for the waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
treatmentPlantName:
description: 'Name of the waste-water treatment plant corresponding to this observation.'
type: string
x-ngsi:
model: https://schema.org/Text
type: Property
tss:
description: 'Total suspended solids concentration measured in a waste-water treatment plant corresponding to this observation.'
type: number
x-ngsi:
model: https://schema.org/Number
type: Property
type:
description: 'NGSI entity type. It has to be WasteWaterPlant'
enum:
- WasteWaterPlant
type: string
x-ngsi:
type: Property
required:
- id
- type
type: object
x-derived-from: ""
x-disclaimer: 'Redistribution and use in source and binary forms, with or without modification, are permitted provided that the license conditions are met. Copyleft (c) 2021 Contributors to Smart Data Models Program'
x-license-url: https://github.com/smart-data-models/dataModel.WasteWater/blob/master/WasteWaterPlant/LICENSE.md
x-model-schema: https://smart-data-models.github.io/dataModel.WasteWater/WasteWaterPlant/schema.json
x-model-tags: IUDX
x-version: 0.0.2 Example payloads
WasteWaterPlant NGSI-v2 key-values Example
Here is an example of a WasteWaterPlant in JSON-LD format as key-values. This is compatible with NGSI-v2 when using options=keyValues and returns the context data of an individual entity.
{
"id": "uri:ngsi-ld:1234:A43R",
"type": "WasteWaterPlant",
"no3": 10,
"bod": 250,
"inFlow": 5,
"toc": 0.7,
"nh4": 50,
"redox": 25,
"do": 4,
"treatmentPlantId": 7,
"outFlow": 6.7,
"tss": 2,
"treatmentPlantCapacity": 10,
"tic": 2,
"tn": 9,
"po4": 6,
"cod": 25,
"treatmentPlantName": "A",
"treatmentPlantCode": "2",
"observationDateTime": "2021-03-11T15:51:02+05:30",
"pHTSA": {
"avgOverTime": 8,
"maxOverTime": 10,
"instValue": 6,
"minOverTime": 6
},
"municipalityInfo": {
"district": "Bangalore Urban",
"ulbName": "BMC",
"cityId": "23",
"wardId": "23",
"stateName": "Karnataka",
"cityName": "Bangalore",
"zoneName": "South",
"wardName": "Bangalore Urban",
"zoneId": "2",
"wardNum": 4
}
} WasteWaterPlant NGSI-v2 normalized Example
Here is an example of a WasteWaterPlant in JSON-LD format as normalized. This is compatible with NGSI-v2 when not using options and returns the context data of an individual entity.
{
"id": "uri:ngsi-ld:1234:A43R",
"type": "WasteWaterPlant",
"no3": {
"type": "Number",
"value": 10
},
"bod": {
"type": "Number",
"value": 250
},
"inFlow": {
"type": "Number",
"value": 5
},
"toc": {
"type": "Number",
"value": 0.7
},
"nh4": {
"type": "Number",
"value": 50
},
"redox": {
"type": "Number",
"value": 25
},
"do": {
"type": "Number",
"value": 4
},
"treatmentPlantId": {
"type": "Number",
"value": 7
},
"outFlow": {
"type": "Number",
"value": 6.7
},
"tss": {
"type": "Number",
"value": 2
},
"treatmentPlantCapacity": {
"type": "Number",
"value": 10
},
"tic": {
"type": "Number",
"value": 2
},
"tn": {
"type": "Number",
"value": 9
},
"po4": {
"type": "Number",
"value": 6
},
"cod": {
"type": "Number",
"value": 25
},
"treatmentPlantName": {
"type": "Number",
"value": "A"
},
"treatmentPlantCode": {
"type": "Number",
"value": "2"
},
"observationDateTime": {
"type": "DateTime",
"value": "2021-03-11T15:51:02+05:30"
},
"pHTSA": {
"type": "StructuredValue",
"value": {
"avgOverTime": 8,
"maxOverTime": 10,
"instValue": 6,
"minOverTime": 6
}
},
"municipalityInfo": {
"type": "StructuredValue",
"value": {
"district": "Bangalore Urban",
"ulbName": "BMC",
"cityId": "23",
"wardId": "23",
"stateName": "Karnataka",
"cityName": "Bangalore",
"zoneName": "South",
"wardName": "Bangalore Urban",
"zoneId": "2",
"wardNum": 4
}
}
} WasteWaterPlant NGSI-LD key-values Example
Here is an example of a WasteWaterPlant in JSON-LD format as key-values. This is compatible with NGSI-LD when using options=keyValues and returns the context data of an individual entity.
{
"id": "uri:ngsi-ld:1234:A43R",
"type": "WasteWaterPlant",
"no3": 10,
"bod": 250,
"inFlow": 5,
"toc": 0.7,
"nh4": 50,
"redox": 25,
"do": 4,
"treatmentPlantId": 7,
"outFlow": 6.7,
"tss": 2,
"treatmentPlantCapacity": 10,
"tic": 2,
"tn": 9,
"po4": 6,
"cod": 25,
"treatmentPlantName": "A",
"treatmentPlantCode": "2",
"observationDateTime": "2021-03-11T15:51:02+05:30",
"pHTSA": {
"avgOverTime": 8,
"maxOverTime": 10,
"instValue": 6,
"minOverTime": 6
},
"municipalityInfo": {
"district": "Bangalore Urban",
"ulbName": "BMC",
"cityId": "23",
"wardId": "23",
"stateName": "Karnataka",
"cityName": "Bangalore",
"zoneName": "South",
"wardName": "Bangalore Urban",
"zoneId": "2",
"wardNum": 4
},
"@context": "iudx:WasteWaterMgmt"
} WasteWaterPlant NGSI-LD normalized Example
Here is an example of a WasteWaterPlant in JSON-LD format as normalized. This is compatible with NGSI-LD when not using options and returns the context data of an individual entity.
{
"id": "uri:ngsi-ld:1234:A43R",
"type": "WasteWaterPlant",
"no3": {
"type": "Property",
"value": 10
},
"bod": {
"type": "Property",
"value": 250
},
"inFlow": {
"type": "Property",
"value": 5
},
"toc": {
"type": "Property",
"value": 0.7
},
"nh4": {
"type": "Property",
"value": 50
},
"redox": {
"type": "Property",
"value": 25
},
"do": {
"type": "Property",
"value": 4
},
"treatmentPlantId": {
"type": "Property",
"value": 7
},
"outFlow": {
"type": "Property",
"value": 6.7
},
"tss": {
"type": "Property",
"value": 2
},
"treatmentPlantCapacity": {
"type": "Property",
"value": 10
},
"tic": {
"type": "Property",
"value": 2
},
"tn": {
"type": "Property",
"value": 9
},
"po4": {
"type": "Property",
"value": 6
},
"cod": {
"type": "Property",
"value": 25
},
"treatmentPlantName": {
"type": "Property",
"value": "A"
},
"treatmentPlantCode": {
"type": "Property",
"value": "2"
},
"observationDateTime": {
"type": "Property",
"value": {
"@type": "DateTime",
"@value": "2021-03-11T15:51:02+05:30"
}
},
"pHTSA": {
"type": "Property",
"value": {
"avgOverTime": 8,
"maxOverTime": 10,
"instValue": 6,
"minOverTime": 6
}
},
"municipalityInfo": {
"type": "Property",
"value": {
"district": "Bangalore Urban",
"ulbName": "BMC",
"cityId": "23",
"wardId": "23",
"stateName": "Karnataka",
"cityName": "Bangalore",
"zoneName": "South",
"wardName": "Bangalore Urban",
"zoneId": "2",
"wardNum": 4
}
},
"@context": [
"iudx:WasteWaterMgmt",
"https://smartdatamodels.org/context.jsonld"
]
} See FAQ 10 to get an answer on how to deal with magnitude units
WasteWaterPlant adopters
description: This is a compilation list of the current adopters of the data model WasteWaterJunction of the Subject dataModel.WasteWater. All fields are non mandatory. More info at https://smart-data-models.github.io/data-models/templates/dataModel/CURRENT_ADOPTERS.yaml
currentAdopters:
-
adopter: IUDX
description: Data model for waste water treatment plant.
mail:
organization: IUDX
project:
comments:
startDate:
