आपकी access key और आपके डेटाबेस से कनेक्शन। कोई मान गायब या अमान्य होने पर स्टार्टअप रुक जाता है।
Human Plugin अपना कॉन्फ़िगरेशन स्टार्टअप पर एक बार environment से पढ़ता है। कोई मान बदलने के लिए container को रीस्टार्ट करना ज़रूरी है।
त्वरित संदर्भ
नीचे दिए गए डिफ़ॉल्ट मानों का उपयोग करने वाले डेटाबेस के लिए न्यूनतम .env:
HUMAN_API_ACCESS_KEY=<your access key>
POSTGRES_ADDRESS_HOST=<database host>
POSTGRES_PASSWORD=<database password>
Access key
| Variable | आवश्यक | नोट्स |
|---|---|---|
HUMAN_API_ACCESS_KEY | हाँ | आपकी access key। यह इंस्टॉलेशन को Unico से जोड़ती है और आपके अकाउंट की पहचान करती है। इसमें whitespace या control characters नहीं होने चाहिए। लॉग में कभी दर्ज नहीं होती |
Access key एक secret है। इसे अपने secret store में रखें और runtime पर container में inject करें।
डेटाबेस कनेक्शन
| Variable | आवश्यक | डिफ़ॉल्ट | नोट्स |
|---|---|---|---|
POSTGRES_ADDRESS_HOST | हाँ | आपके PostgreSQL सर्वर का host name या IP address | |
POSTGRES_PASSWORD | हाँ | इसमें whitespace, single quotes, backslashes या control characters नहीं होने चाहिए। इनमें से कोई भी होने पर Human Plugin शुरू होने से मना कर देता है, और मान को लॉग नहीं करता | |
POSTGRES_ADDRESS_PORT | नहीं | 5432 | |
POSTGRES_USER | नहीं | postgres | Human Plugin के लिए समर्पित role का उपयोग करें |
POSTGRES_DATABASE | नहीं | human_plugin | Human Plugin के लिए समर्पित डेटाबेस का उपयोग करें |
POSTGRES_SSL_MODE | नहीं | require | disable का उपयोग केवल तब करें जब PostgreSQL उसी host पर या sidecar के रूप में चल रहा हो |
डेटाबेस का उपयोग केवल Human Plugin को करना चाहिए। Role के पास उसमें tables बनाने की अनुमति होनी चाहिए: Human Plugin अनुरोध स्वीकार करने से पहले, स्टार्टअप पर अपने tables बनाता और अपडेट करता है।
पासवर्ड एक secret है। इसे अपने secret store में रखें, जैसे आप access key को रखते हैं।
बाकी सब कुछ
बाकी सभी मान image सेट करती है। जब तक Unico न कहे, अन्य variables सेट न करें: वे समर्थित कॉन्फ़िगरेशन का हिस्सा नहीं हैं।
उदाहरण
docker run -d --name human-plugin --stop-timeout 60 -p 127.0.0.1:8080:8080 \
-e HUMAN_API_ACCESS_KEY \
-e POSTGRES_ADDRESS_HOST=db.internal \
-e POSTGRES_USER=human_plugin \
-e POSTGRES_PASSWORD \
pkg.unico.run/human-plugin-api:latest
बिना मान के -e NAME आपके shell से variable पास करता है, इसलिए secrets कमांड लाइन में दिखाई नहीं देते।