ไคลเอนต์ GO API อย่างเป็นทางการสำหรับ HCP Terraform และ Terraform Enterprise
ลูกค้านี้รองรับ HCP Terraform V2 API เนื่องจาก Terraform Enterprise เป็นการกระจายตัวของ HCP Terraform ลูกค้ารายนี้รองรับทั้งกรณีการใช้งาน HCP Terraform และ Terraform Enterprise ในเอกสารประกอบแพ็คเกจทั้งหมดและ API แพลตฟอร์มจะถูกระบุว่าเป็น 'Terraform Enterprise' - แต่คุณลักษณะจะถูกบันทึกไว้อย่างชัดเจนว่ารองรับในหนึ่งหรืออื่น ๆ ถ้ามี (หายาก)
เกือบทุกครั้งการเปลี่ยนแปลงรุ่นรองจะบ่งบอกถึงคุณสมบัติและการปรับปรุงที่เข้ากันได้ย้อนหลัง บางครั้งการเปลี่ยนแปลงลายเซ็นฟังก์ชั่นที่สะท้อนถึงการแก้ไขข้อบกพร่องอาจปรากฏขึ้นเมื่อเปลี่ยนรุ่นรอง การเปลี่ยนแปลงเวอร์ชันแพตช์จะใช้สำหรับการแก้ไขข้อผิดพลาดการปรับปรุงประสิทธิภาพและการเปลี่ยนแปลงที่ไม่ได้รับผลกระทบ
สร้างไคลเอนต์ TFE ใหม่จากนั้นใช้จุดสิ้นสุดต่างๆบนไคลเอนต์เพื่อเข้าถึงส่วนต่าง ๆ ของ Terraform Enterprise API ตัวอย่างต่อไปนี้แสดงรายการองค์กรทั้งหมด
import (
"context"
"log"
"github.com/hashicorp/go-tfe"
)
config := & tfe. Config {
Address : "https://tfe.local" ,
Token : "insert-your-token-here" ,
RetryServerErrors : true ,
}
client , err := tfe . NewClient ( config )
if err != nil {
log . Fatal ( err )
}
orgs , err := client . Organizations . List ( context . Background (), nil )
if err != nil {
log . Fatal ( err )
}
การกำหนดค่าเริ่มต้นใช้ประโยชน์จากตัวแปรสภาพแวดล้อม TFE_ADDRESS
และ TFE_TOKEN
TFE_ADDRESS
- URL ของอินสแตนซ์ HCP Terraform หรือ Terraform Enterprise ตัวอย่าง: https://tfe.local
TFE_TOKEN
- โทเค็น API สำหรับอินสแตนซ์ HCP Terraform หรือ Terraform Enterprise หมายเหตุ: อีกทางเลือกหนึ่งคุณสามารถตั้ง TFE_HOSTNAME
ซึ่งทำหน้าที่เป็นทางเลือกสำหรับ TFE_ADDRESS
จะใช้เฉพาะในกรณีที่ไม่ได้ตั้งค่า TFE_ADDRESS
และจะแก้ไขโฮสต์เป็นโครงการ https
ตัวอย่าง: tfe.local
=> แก้ไขเป็น https://tfe.local
ตัวแปรสภาพแวดล้อมถูกใช้เป็นทางเลือกในการกำหนดค่าไคลเอนต์ TFE หากไม่มีค่าที่อยู่หรือโทเค็นในกรณีด้านล่าง:
import (
"context"
"log"
"github.com/hashicorp/go-tfe"
)
// Passing nil to tfe.NewClient method will also use the default configuration
client , err := tfe . NewClient ( tfe . DefaultConfig ())
if err != nil {
log . Fatal ( err )
}
orgs , err := client . Organizations . List ( context . Background (), nil )
if err != nil {
log . Fatal ( err )
}
import (
"context"
"log"
"github.com/hashicorp/go-tfe"
)
config := & tfe. Config {
Address : "" ,
Token : "" ,
}
client , err := tfe . NewClient ( config )
if err != nil {
log . Fatal ( err )
}
orgs , err := client . Organizations . List ( context . Background (), nil )
if err != nil {
log . Fatal ( err )
}
สำหรับการใช้งานไคลเอนต์ API ที่สมบูรณ์ให้ดูเอกสารแพ็คเกจเต็มรูปแบบ
ไคลเอนต์ API นี้ครอบคลุมการโทร HCP Terraform API ที่มีอยู่ส่วนใหญ่และได้รับการปรับปรุงเป็นประจำเพื่อเพิ่มจุดสิ้นสุดใหม่หรือที่หายไป
ดูไดเรกทอรีตัวอย่าง
ดูการทดสอบ MD
ดูการสนับสนุน. md
ดู releases.md