1<!-- Code generated by gomarkdoc. DO NOT EDIT -->
2
3# v1alpha1
4
5```go
6import "github.com/cert-manager/issuer-lib/api/v1alpha1"
7```
8
9Package v1alpha1 contains API Schema definitions for the v1alpha1 API group \+kubebuilder:object:generate=true \+groupName=issuer.cert\-manager.io
10
11## Index
12
13- [Constants](<#constants>)
14- [type Issuer](<#Issuer>)
15- [type IssuerStatus](<#IssuerStatus>)
16 - [func \(in \*IssuerStatus\) DeepCopy\(\) \*IssuerStatus](<#IssuerStatus.DeepCopy>)
17 - [func \(in \*IssuerStatus\) DeepCopyInto\(out \*IssuerStatus\)](<#IssuerStatus.DeepCopyInto>)
18
19
20## Constants
21
22<a name="IssuerConditionReasonInitializing"></a>
23
24```go
25const (
26 // IssuerConditionReasonInitializing is the value assigned to
27 // the Reason field of the Ready condition when issuer-lib first
28 // reconciles an Issuer which does not already have a Ready
29 // condition.
30 IssuerConditionReasonInitializing = "Initializing"
31
32 IssuerConditionReasonPending = "Pending"
33
34 IssuerConditionReasonChecked = "Checked"
35
36 IssuerConditionReasonFailed = "Failed"
37)
38```
39
40<a name="CertificateRequestConditionReasonInitializing"></a>
41
42```go
43const (
44 // CertificateRequestConditionReasonInitializing is the value assigned to
45 // the Reason field of the Ready condition when issuer-lib first
46 // reconciles a CertificateRequest which does not already have a Ready
47 // condition.
48 CertificateRequestConditionReasonInitializing = "Initializing"
49)
50```
51
52<a name="Issuer"></a>
53## type [Issuer](<https://github.com/cert-manager/issuer-lib/blob/main/api/v1alpha1/issuer_interface.go#L27-L41>)
54
55
56
57```go
58type Issuer interface {
59 runtime.Object
60 metav1.Object
61 GetStatus() *IssuerStatus
62
63 // GetIssuerTypeIdentifier returns a string that uniquely identifies the
64 // issuer type. This should be a constant across all instances of this
65 // issuer type. This string is used as a prefix when determining the
66 // issuer type for a Kubernetes CertificateSigningRequest resource based
67 // on the issuerName field. The value should be formatted as follows:
68 // "<issuer resource (plural)>.<issuer group>". For example, the value
69 // "simpleclusterissuers.issuer.cert-manager.io" will match all CSRs
70 // with an issuerName set to eg. "simpleclusterissuers.issuer.cert-manager.io/issuer1".
71 GetIssuerTypeIdentifier() string
72}
73```
74
75<a name="IssuerStatus"></a>
76## type [IssuerStatus](<https://github.com/cert-manager/issuer-lib/blob/main/api/v1alpha1/issuer_status_types.go#L23-L30>)
77
78
79
80```go
81type IssuerStatus struct {
82 // List of status conditions to indicate the status of an Issuer.
83 // Known condition types are `Ready`.
84 // +listType=map
85 // +listMapKey=type
86 // +optional
87 Conditions []cmapi.IssuerCondition `json:"conditions,omitempty"`
88}
89```
90
91<a name="IssuerStatus.DeepCopy"></a>
92### func \(\*IssuerStatus\) [DeepCopy](<https://github.com/cert-manager/issuer-lib/blob/main/api/v1alpha1/zz_generated.deepcopy.go#L40>)
93
94```go
95func (in *IssuerStatus) DeepCopy() *IssuerStatus
96```
97
98DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IssuerStatus.
99
100<a name="IssuerStatus.DeepCopyInto"></a>
101### func \(\*IssuerStatus\) [DeepCopyInto](<https://github.com/cert-manager/issuer-lib/blob/main/api/v1alpha1/zz_generated.deepcopy.go#L28>)
102
103```go
104func (in *IssuerStatus) DeepCopyInto(out *IssuerStatus)
105```
106
107DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non\-nil.
108
109Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)
View as plain text