Skip to main content
Calico Enterprise 3.19 (latest) documentation

Inventory report

To create an Inventory report, create a GlobalReport with the reportType set to inventory.

The following sample command creates a GlobalReport that results in a daily inventory report for endpoints in the public namespace.

kubectl apply -f - << EOF
apiVersion: projectcalico.org/v3
kind: GlobalReport
metadata:
name: daily-public-inventory-report
labels:
deployment: production
spec:
reportType: inventory
endpoints:
namespaces:
names:
- public
schedule: 0 0 * * *
EOF

Downloadable reports

summary.csv

A summary CSV file that includes details about the report parameters and the top level counts.

HeadingDescriptionFormat
startTimeThe report interval start time.RFC3339 string
endTimeThe report interval end time.RFC3339 string
endpointSelectorThe endpoint selector used to restrict in-scope endpoints by endpoint label selection.selector string
namespaceNamesThe set of namespace names used to restrict in-scope endpoints by namespace.";" separated list of namespace names
namespaceSelectorThe namespace selector used to restrict in-scope endpoints by namespace label selection.selector string
serviceAccountNamesThe set of service account names used to restrict in-scope endpoints by service account.";" separated list of service account names
serviceAccountSelectorsThe service account selector used to restrict in-scope endpoints by service account label selection.selector string
endpointsNumInScopeThe number of enumerated endpoints that are in-scope according to the requested endpoint selection options.number
endpointsNumIngressProtectedThe number of in-scope endpoints that were always ingress protected during the report interval.number
endpointsNumEgressProtectedThe number of in-scope endpoints that were always egress protected during the report interval.number
namespacesNumInScopeThe number of namespaces containing in-scope endpoints.number
namespacesNumIngressProtectedThe number of namespaces whose in-scope endpoints were always ingress protected during the report interval.number
namespacesNumEgressProtectedThe number of namespaces whose in-scope endpoints were always egress protected during the report interval.number
serviceAccountsNumInScopeThe number of service accounts associated with in-scope endpoints.number

endpoints.csv

An endpoints CSV file that includes per-endpoint information.

HeadingDescriptionFormat
endpointThe name of the endpoint.string
ingressProtectedWhether the endpoint was always ingress protected during the report interval.bool
egressProtectedWhether the endpoint was always egress protected during the report interval.bool
envoyEnabledWhether the endpoint was always Envoy enabled during the report interval.bool
appliedPoliciesThe full set of policies that applied to the endpoint at any time during the report interval.";" separated list of policy names
servicesThe full set of services that included this endpoint at any time during the report interval.";" separated list of service names

namespaces.csv

A namespaces CSV file that includes per-namespace information.

HeadingDescriptionFormat
namespaceThe name of the namespace.string
ingressProtectedWhether all in-scope endpoints within the namespace were always ingress protected during the report interval.bool
egressProtectedWhether all in-scope endpoints within the namespace were always egress protected during the report interval.bool
envoyEnabledWhether all in-scope endpoints within the namespace were always Envoy enabled during the report interval.bool

services.csv

A services CSV file that includes per-service information.

HeadingDescriptionFormat
serviceThe name of the service.string
ingressProtectedWhether all in-scope endpoints that are in the service were always ingress protected during the report interval.bool
envoyEnabledWhether all in-scope endpoints that are in the service were always Envoy enabled during the report interval.bool